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

added config settings #29

Merged
merged 6 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.2.0
current_version = 1.2.1
commit = True
message = Bumps version to {new_version}
tag = False
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

### [1.2.1] (https://github.com/plus3it/repo-template/releases/tag/1.2.1)

**Summary**:

* Updated README.md to include config settings for github
* Updated LICENSE copyright year

### [1.2.0] (https://github.com/plus3it/repo-template/releases/tag/1.2.0)

**Summary**:
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2023 Maintainers of plus3it/repo-template
Copyright 2024 Maintainers of plus3it/repo-template

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,35 @@ To use this template:
1. Select the green "Use this template" button, or [click here](https://github.com/plus3it/repo-template/generate).
2. Select the repo Owner, give the repo a name, enter a description, select Public or Private, and click "Create repository from template".
3. Clone the repository and create a new branch.
4. Edit the following files to customize them for the new repository:
4. Configure the following settings on your new repo.
* `GENERAL`
* `Features`
* Turn off Wikis
* `Pull Requests`
* Turn off Squash Merging
* Turn off Rebase Merging
* Turn on Allow Auto-Merge
* Turn on Automatically delete head branches
* `Pushes`
* Limit how many branches can be updated in a single push: 2
* `COLLABORATORS and TEAMS`
* `Manage Access`
* Add relevant team roles, for example
* `tardigrade-admins` (as admin)
* `terraform` (as maintainer)
* `Branches`
* `Create Branch Protection rule`
* Turn on Require pull request before merging
* Turn on Require approvals
* Turn on Dismiss stale pull requests...
* `Required Status Checks`
* As relevant to projects, for example
* WIP
* lint/actionlint
* lint/tardigradelint
* release / test / mockstacktest
* Turn on Do not allow bypassing the above settings
5. Edit the following files to customize them for the new repository:
* `LICENSE`
* Near the end of the file, edit the date and change the repository name
* `CHANGELOG.template.md`
Expand All @@ -20,4 +48,4 @@ To use this template:
* `.github/`
* Inspect dependabot and workflow files in case changes are needed for
the new repo
5. Commit the changes and open a pull request
6. Commit the changes and open a pull request