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

Feature: Generating private repositories #52

Merged
merged 11 commits into from
Jan 5, 2024
Merged

Conversation

notsatan
Copy link
Owner

@notsatan notsatan commented Jan 5, 2024

Description

Up until now, projects were generated by go-template under the assumption that they will always be public — which, isn't always true. Private projects would end up with broken links on their README because shields.io can't access the project!

This feature intends to resolve this by removing/updating the links on the generated README to ensure private repositories can generate a project with this template and use it right out of box

Type of Change

  • 📚 Documentation (Non-breaking change; Changes in the documentation)
  • 🔧 Bug fix (Non-breaking change; Fixes an existing bug)
  • 🥂 Improvement (Non-breaking change; Improves existing feature)
  • 🚀 New feature (Non-breaking change; Adds functionality)
  • 🔐 Security fix (Non-breaking change; Patches a security issue)
  • 💥 Breaking change (Breaks existing functionality)

Review Process

Reviewees:

  1. Prefer incremental and appropriately-scoped changes.
  2. Leave a comment on things you want explicit feedback on.
  3. Respond clearly to comments and questions.

Reviewers:

  1. Test functionality using the criteria above.
  2. Offer tips for efficiency, feedback on best practices, and possible alternative approaches.
  3. For shorter, "quick" PRs, use your best judgment on the previous point.
  4. Use a collaborative approach and provide resources and/or context where appropriate.
  5. Provide screenshots/grabs where appropriate to show findings during review.
  6. In case of a potential bug in PR, be sure to add steps to reproduce the issue (where applicable)

Something I was planning to do since sometime — allow generating
private projects via `go-template`

Up until now, projects were generated by `go-template` under the
assumption that they will always be public — which, isn't always
true. Private projects would end up with broken links on their
README because shields.io can't reach the project!

This commit is the first step in this direction

Signed-off-by: notsatan <[email protected]>
The README's for generated projects would now be able to handle
cases where the project is private — badges would be hidden or
modified based on this

Signed-off-by: notsatan <[email protected]>
Update the versions of Go supported

Signed-off-by: notsatan <[email protected]>
Apparently some upstream issue with the badges caused a badge on
the homepage to break down. This commit should fix that

Signed-off-by: notsatan <[email protected]>
@notsatan notsatan self-assigned this Jan 5, 2024
@notsatan notsatan added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 5, 2024
The pre-gen Python script had a typo in the name of a function

Signed-off-by: notsatan <[email protected]>
With this commit, the recent changes allowing users to use this
template to generate private projects have been documented in the
project README

Signed-off-by: notsatan <[email protected]>
Signed-off-by: notsatan <[email protected]>
This directly relates to #43, with this in place
there is no longer a need to decide where to store stderr logs

Signed-off-by: notsatan <[email protected]>
@notsatan notsatan merged commit 2620736 into master Jan 5, 2024
1 check passed
@notsatan notsatan deleted the feature/private-repo branch January 5, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant