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

OPCT-239: create basic changelog builder based in commits #74

Conversation

mtulio
Copy link
Contributor

@mtulio mtulio commented Jul 20, 2023

Generate changelog by commits when mkdocs is building the docs.

The reason for this change is to improve the report for each release, currently, there is a GitHub action that generates a delta when a new release is created but the delta is always based on the last GitHub release, not the last Major version, most interested by us as the project uses SemVer standards.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 20, 2023
@mtulio mtulio changed the title create simple changelog builder based in tags OPCT-239: create simple changelog builder based in tags Jul 24, 2023
@mtulio mtulio changed the title OPCT-239: create simple changelog builder based in tags OPCT-239: create basic changelog builder based in commits Jul 24, 2023
hack/generate-changelog.sh Outdated Show resolved Hide resolved
@mtulio mtulio marked this pull request as ready for review August 25, 2023 21:01
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 25, 2023
@mtulio mtulio added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 25, 2023
@mtulio
Copy link
Contributor Author

mtulio commented Aug 25, 2023

Ready for review.
Wait to merge in a few weeks to review it after merged.
/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 25, 2023
@mtulio
Copy link
Contributor Author

mtulio commented Sep 11, 2023

/unhold

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 11, 2023
@mtulio
Copy link
Contributor Author

mtulio commented Sep 21, 2023

Open questions:

  • do we need to keep a versioned file instead of generating one, to keep compliant with Github opensource project? Or just create a static pointing to the generated HTML page?

@rvanderp3
Copy link
Contributor

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 21, 2023
@openshift-ci
Copy link

openshift-ci bot commented Sep 21, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rvanderp3

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 21, 2023
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 21, 2023
@rvanderp3
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 21, 2023
@openshift-merge-robot openshift-merge-robot merged commit 94c1575 into redhat-openshift-ecosystem:main Sep 21, 2023
6 checks passed
@mtulio mtulio deleted the build-changelog-docs branch September 21, 2023 20:45
mtulio added a commit that referenced this pull request Sep 21, 2023
#78)

Fixes #74 :
- the CHANGELOG.md is generated by CI and available only in the rendered
page. If we decide to keep it versioned, we can add it in the future.
For now it is generated automatically
- force CI step/action to fetch tags to run correctly the changelog
generator
- nits shell script
mtulio added a commit that referenced this pull request Sep 25, 2023
Fixes #74 :
- the CHANGELOG.md is generated by CI and available only in the rendered
page. If we decide to keep it versioned, we can add it in the future.
For now it is generated automatically
- force CI step/action to fetch tags to run correctly the changelog
generator
- nits shell script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants