sourcecred / github-workflow-examples

GitHub action to generate a sourcecred prototype or graphic for your repository

Packages in this repository

This repository is a monorepo, meaning it is set up to contain multiple distinct packages, although for now it only contains one.

Package Name	Description	Subdirectory with README
sourcecred	A monolith package containing the CLI that supports instances, our JS library, and all of our supported platform plugins.	link

github-workflow-examples's Issues

Look into caching of content for GitHub Actions

Per @Beanow comment:

The data volume used, is that discarded every run? If so, for a larger repository it's probably worth looking into caching it.

We might want to cache the content, which would be helpful for a larger repository. This could be implemented in all workflow recipes.

When cred-action (to be named differently) done, use it in examples here

When the cred-action is done and added to the Sourcecred organization, it would make sense to simplify the github workflow examples here to use it.

Possible to commit directly?

The action currently creates a PR, would we be able make a variant that commits to master or gh-pages as well?

For context, this is what I do now using a DroneCI daily cron, to build the frontend and widgets.

Change frequency of automated example action to once a month

Bug with order of pull for contributors automated

See https://github.com/sourcecred/sourcecred-action/runs/502221614?check_suite_focus=true

Edit pull request frequency

Currently, the PRs go out every Sunday, which is way too often as the repository is unlikely to change and I don't want to handle the PRs each week if they aren't necessary. Akin to the automated, I want to update the cron times to only less frequently - since automated is 1/month, the pull request version should be run just once a year (if we even need that)!

Do not push with --allow-empty if there are no changes

Currently, the workflows will still open a pull request or commit if there are no changes to the graphic. Although this is unlikely for an active repository, we should remove the --allow-empty and catch the error and still return success if it's not opened. There might be a better command to do the check, but first I'm just going to try adding || echo "No changes"