# The SourceCred GitHub Action

**URL:** <https://discourse.sourcecred.io/t/the-sourcecred-github-action/683>\
**Category:** Initiatives\
**Tags:** 🏗️in-progress\
**Created:** [March 18, 2020, 8:49pm UTC](https://discourse.sourcecred.io/t/the-sourcecred-github-action/683 "2020-03-18T20:49:44Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Beanow](https://yyz2.discourse-cdn.com/flex032/user_avatar/discourse.sourcecred.io/beanow/32/98_2.png) [@Beanow](https://discourse.sourcecred.io/u/Beanow)\
**Post date:** [March 18, 2020, 8:49pm UTC](https://discourse.sourcecred.io/t/the-sourcecred-github-action/683/1 "2020-03-18T20:49:44Z")

</div>

# Status: In progress

* * *

# Champion

* * *

- @vsoch

  

# Description

* * *

As touched on in [Productivity / Quality of Life for instance maintainers](https://discourse.sourcecred.io/t/productivity-quality-of-life-for-instance-maintainers/651), there’s a clear need to automate maintenance tasks surrounding a SourceCred instance.

This GitHub action will provide an easy to adopt, reproducible way to keep SourceCred instances up to date. By way of wrapping sourcecred in a container with variables exposed via the GitHub actions interface (action.yml) we can easily update the internals without changing the UI.

  

# Implementation plan

* * *

1. Research options and build a prototype (already available).
2. Move the prototype to the SourceCred organization ([#11](https://github.com/vsoch/cred-action/issues/11)).
3. Coordinate with [SourceCred Instance System](https://discourse.sourcecred.io/t/sourcecred-instance-system/244) to have a compatible & similar interface.
4. Publish on GitHub Marketplace
5. Write (or link to) example recipes, write a tutorial or blog post
6. (… expand here)

  

# Deliverables

* * *

- The `sourcecred/action` (or similarly named) repository exposes a GitHub action, published and versioned on the GitHub marketplace, for easy usage.
- At least one blog / tutorial with examples.

  

# Dependencies

* * *
  

# References

* * *

- [SourceCred Instance System](https://discourse.sourcecred.io/t/sourcecred-instance-system/244) - Design doc for this.

  

# Contributions

* * *

- Too many to link 🙂

---

<div class="post-metadata">

**Author:** ![Beanow](https://yyz2.discourse-cdn.com/flex032/user_avatar/discourse.sourcecred.io/beanow/32/98_2.png) [@Beanow](https://discourse.sourcecred.io/u/Beanow)\
**Post date:** [March 18, 2020, 8:58pm UTC](https://discourse.sourcecred.io/t/the-sourcecred-github-action/683/2 "2020-03-18T20:58:05Z")

</div>

@anon60584824 I’ve created a placeholder for this initiative.

Feel free to edit this as you see fit. And whether or not you would like to champion, I would endorse and believe you currently are the champion, but don’t want to decide this for you 😄

How these initiatives relate:

I intended to describe the overall goals with [Productivity / Quality of Life for instance maintainers](https://discourse.sourcecred.io/t/productivity-quality-of-life-for-instance-maintainers/651) (Make config / CLI simpler, automate maintainer tasks, …)

Which I’d split up into smaller initiatives, such as this one for the GitHub action, and the [SourceCred Instance System](https://discourse.sourcecred.io/t/sourcecred-instance-system/244) currently. Possibly more spawn out of it :]

---

<div class="post-metadata">

**Author:** ![Beanow](https://yyz2.discourse-cdn.com/flex032/user_avatar/discourse.sourcecred.io/beanow/32/98_2.png) [@Beanow](https://discourse.sourcecred.io/u/Beanow)\
**Post date:** [March 18, 2020, 10:11pm UTC](https://discourse.sourcecred.io/t/the-sourcecred-github-action/683/4 "2020-03-18T22:11:50Z")

</div>

> [@anon60584824](#):
>
> Let me know when you’ve had a chance to review the PR to add testing so we can unblock William.

Will do! Btw, I would encourage to use GitHub’s request to review for all the actions work you would like to me to look at:

![image](https://canada1.discourse-cdn.com/flex032/uploads/sourcecred1/original/1X/9aef0b31c31e29090f8d37628427507af89648f2.png)