Skip to content

CSDA Version

Actions

About

Calculate the next CSDA version for this repository
v0.2.11
Latest
Star (0)

csda-version

A Github action to calculate the next CSDA version for the checked-out repository.

To use with release-please:

  steps:
    - name: CSDA Version
      id: csda-version
      uses: NASA-IMPACT/csda-version@<hash-version> # hash-version is recommended for extra security 
    - uses: googleapis/release-please-action@<hash-version> # hash-version is recommended for extra security
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        release-type: simple
        release-as: ${{ steps.csda-version.outputs.version }}
        config-file: ${{ steps.csda-version.outputs.release-please-config }}

Important

You must use release-type in your Github Action YAML, you cannot use Manifest Driven releasing. This is because release-as is ignored for manifest-driven releases.

To see this in action, check out https://github.com/NASA-IMPACT/csdap-frontend/blob/main/.github/workflows/release-please.yml.

CSDA version

A CSDA version is formatted like vYY.PI.SP-X, where:

  • YY is the last two digits of the year,
  • PI is the "program increment", which is like a normal calendar quarter except that PI 1 starts Oct 1
  • SP is the sprint number
  • X is the release number in this sprint

Note

While the CSDA version can be updated manually (see example commit), there is a Github cron job that runs weekly to handle routine updates.

Included Commit Prefixes

The following commit prefixes are included in the CHANGELOG:

  • feat: Features
  • fix: Bug Fixes
  • refactor: Refactor
  • chore: Chores
  • docs: Documentation
  • revert: Revert

Commits with other prefixes will not appear in the generated changelog, but will still be included in the release.

CSDA Version is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Calculate the next CSDA version for this repository
v0.2.11
Latest

CSDA Version is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.