Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog #45

Open
ales-tsurko opened this issue Mar 22, 2024 · 2 comments
Open

Add changelog #45

ales-tsurko opened this issue Mar 22, 2024 · 2 comments
Labels
devops enhancement New feature or request

Comments

@ales-tsurko
Copy link
Member

We should considered wether the changelog should be generated from the commit history or modified manually.

In case of manual logging we need to configure CI/CD so that it checks the changelog updataed on new release (or, for example, branch merge).

In case of generated changelog, we should prevent it to be messy and configure CI/CD, which would check the style (for example, merge commit messages). Also, we should have strict guideline related to commit messages or anything else which would go into the log.

We should avoid to switching conventional commits for that, as the changelogs generated from repos sticked to this practice use to have messy changelogs.

For the changelog itself, we should follow these guidelines.

@ales-tsurko ales-tsurko added the enhancement New feature or request label Mar 22, 2024
@ales-tsurko
Copy link
Member Author

In discussion we considered doing it this way:

  • the changelog will be generated in accordance to these guidelines
  • the records in changelog are generated from merge commits only
  • we need to add validation of merge commits messages to make them suitable for the changelog and to restrict how the message can look like
    • the validation should allow only valid merge commit message to merge
  • the changelog will be generated only on testnet release (and on mainnet in the future)
    • the release will have semantic versioning
    • we should change docker image tagging for testnet and devnet like this:
      • instead of <netname>-<date>-<timestamp> it should be <netname>-nightly-<date>-<timestamp> (for ex., devnet-nightly-28032024-142503)
      • instead of <netname>-latest for current release which we make for images when we push changes to git branches, we need <netname>-nightly-latest (for ex., devnet-nightly-latest)
      • for actual release we need to push an image which should look like <netname>-<version> and <netname>-latest (for ex., testnet-v0.1.1 and testnet-latest)

@ales-tsurko ales-tsurko assigned ales-tsurko and unassigned Kille135 Apr 16, 2024
@ales-tsurko ales-tsurko removed their assignment Jul 22, 2024
@hrls
Copy link
Collaborator

hrls commented Jul 25, 2024

https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants