search

ansible-community / community-team

For issues to be done by the Community Team that don't fall into a particular repository
0 stars 2 forks source link

Task: Investigate how to show changeset between builds more easily #532

Closed oraNod closed 5 months ago

oraNod commented 6 months ago

Relates to https://github.com/ansible-community/community-team/issues/516

From discussion at the DaWGs meeting, a potential improvement for the workflow to publish package docs is to add some logic to show the changeset between builds more clearly. This could be part of the deploy side.

oraNod commented 5 months ago

I think the approach to push generated HTML and other build resources to a destination repo solves this for us. We can use the GitHub UI in the browser to view commit history and the diff between files. If necessary we can just clone the repo and use git diff or other commands to show the changeset.

The descriptive names in commit messages also help identify differences using this format: YYYY-MM-DD-<github.run_id>-<github.run_number>-<github.run_attempt>

This means we can associate each commit with a specific workflow run and trace back to the source repo and examine logs if/when necessary.