GSA-TTS / usagov-benefits-eligibility

Benefits eligibility estimator tool for USAGov.
22 stars 5 forks source link

Discover Automating the Release Process #756

Closed FatmaBakir closed 1 year ago

FatmaBakir commented 1 year ago

Description

Discover Automating the Release Process

User Story

No response

Architectural Decision Records (ADRs)

No response

FatmaBakir commented 1 year ago

The below GH Action can be used to automate the release process:

automatic-releases

tl;dr: It will create a new GitHub release when tags are pushed to the repository.

Steps involved with the process are as follows:

  1. Create a workflow yaml file in .github/workflows directory similar to following example: `--- name: "tagged-release"

on: push: tags:

jobs: tagged-release: name: "Tagged Release" runs-on: "ubuntu-latest"

steps:
  # ...
  - name: "Build & test"
    run: |
      echo "done!"

  - uses: "marvinpinto/action-automatic-releases@latest"
    with:
      repo_token: "${{ secrets.GITHUB_TOKEN }}"
      prerelease: false

---`

  1. Make all the changes and push your commits up
  2. git tag and git push
FatmaBakir commented 1 year ago

@scottqueen-bixal This seems to be a light lift. I am not sure if we should implement this for v1 but I believe this could be a good option for v2.

I've included one way to do it in the comments above but there are other actions that are available in case this one doesn't satify what we are looking for.