Skip to content

V0.2.0 review updates #46

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

Merged
merged 41 commits into from
Jul 26, 2022
Merged

V0.2.0 review updates #46

merged 41 commits into from
Jul 26, 2022

Conversation

haani-niyaz
Copy link
Collaborator

@haani-niyaz haani-niyaz commented Jul 10, 2022

Change Summary

Docs update

  1. Readme has been rewritten to access starter docs
  2. Add sample README template
  3. Fixed pre-commit docs to capture pre-commit ci integration
  4. Follow a consistent naming convention for workflow names and steps
  5. Use a lowercase file naming convention for workflows (It doesn't have to be lowercase but I picked this to keep all of them consistent)
  6. Add GoReleaser docs

Closes #44

Limit builds

  • Removed gh action on:pull_request since on:push results are available in the PR and this will avoid duplicate runs

Addresses #43

Dockerfile enhancements

Closes #45 .

- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
- name: Install mkdocs-material
run: pip install mkdocs-material
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should consider using a golang alternative for mkdocs as its sad a golang template repo needs python 😄

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make a fresh issue for this @mridulganga, we went for anything that we were able to get working.

Now, would be a good time to start working on evaluating and taking out non-golang bits.

@shukra-in-spirit
Copy link
Contributor

shukra-in-spirit commented Jul 12, 2022

Thanks, @haani-niyaz and @mridulganga for the help.
@haani-niyaz have you added the comment to trigger the semantic releaser and make it v0.2.0? I am approving the PR, can you merge it if the comment message is apt.
I saw that none of the other commits bumped the bug-fix versions as expected. Maybe, there is a need to encourage members to follow the commit message rules to trigger releases accordingly,

Copy link
Contributor

@shukra-in-spirit shukra-in-spirit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check above comment before merging @haani-niyaz.

@haani-niyaz
Copy link
Collaborator Author

haani-niyaz commented Jul 12, 2022

Thanks, @haani-niyaz and @mridulganga for the help. @haani-niyaz have you added the comment to trigger the semantic releaser and make it v0.2.0? I am approving the PR, can you merge it if the comment message is apt. I saw that none of the other commits bumped the bug-fix versions as expected. Maybe, there is a need to encourage members to follow the commit message rules to trigger releases accordingly,

@shukra-in-spirit, I was planning on merging #45 to this PR as it completes the v0.2.0 release requirements. Once done, I'll bump this with a feat commit to trigger v0.2.0

I saw that none of the other commits bumped the bug-fix versions as expected.

Do you mean with the fix type in the commit message or something else?

I also think some release planning is in order to keep everyone on the same page.

@shukra-in-spirit
Copy link
Contributor

Yeap. With a fix mention in the comment to bump up the x in v0.1.x

@haani-niyaz
Copy link
Collaborator Author

Yeap. With a fix mention in the comment to bump up the x in v0.1.x

@shukra-in-spirit, I don't see any commits with fix type in the main branch's commit log. Possibly squashed when merging.

Mridul Ganga and others added 9 commits July 18, 2022 19:24
fix(Dockerfile): Go image update

What does this commit do?
=========================
* Use alpine Go base image to reduce size
* Reuse make command to build binary

Why are we doing this?
======================
* Shrink image size to increase build times
* Reuse make to provide a single place add binary build updates
…repos using the template

The same project is being used by all repos using the template.

To fix this the project needs to be created in advance and this is also a
pre-requisite as per https://github.com/SonarSource/sonarcloud-github-action#requirements.
This should be automated as part of the workflow. Otherwise, it becomes a bottleneck
for teams trying to onboard and waiting for admins to create the project.
@github-actions
Copy link

🎉 This issue has been resolved in version 0.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refresh README
4 participants