track_open_instances 0.1.11 → 0.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.release-please-manifest.json +1 -1
- data/CHANGELOG.md +8 -0
- data/CONTRIBUTING.md +90 -6
- data/lib/track_open_instances/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ee4204d94143dd1fc33ed919d471780a6555924acbcff72154d762ff11c16263
|
4
|
+
data.tar.gz: a471087b9c689bf1678c0351cc2588b718c20a941f378c08afb8eb398a50fa03
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e7b27a6315256481f06f4ede6ce7296858b41fd1166c33298a8e3501a7dfd3813dd55404c05b5b32d30246f0fa44bdd97fba34e8806b67d1ce055d854885a696
|
7
|
+
data.tar.gz: 580b7e3c621ba50a9dd5c08c0d8c5fbe653e7f5337846704e927ba1fd956a7ba9d4082100cc05a67440e517776485978ab2489805ee7719719aa3e8e9a684894
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Change Log
|
2
2
|
|
3
|
+
## [0.1.12](https://github.com/main-branch/track_open_instances/compare/v0.1.11...v0.1.12) (2025-04-15)
|
4
|
+
|
5
|
+
|
6
|
+
### Bug Fixes
|
7
|
+
|
8
|
+
* Change the release PR title to be more user friendly ([0fb9ce2](https://github.com/main-branch/track_open_instances/commit/0fb9ce2cbac10a4efdf44d47bd0cf316d99fc410))
|
9
|
+
* Remove pull request title pattern from release configuration ([2460dde](https://github.com/main-branch/track_open_instances/commit/2460ddeabd975b42925daf0572220ef6cbe208fd))
|
10
|
+
|
3
11
|
## [0.1.11](https://github.com/main-branch/track_open_instances/compare/v0.1.10...v0.1.11) (2025-04-15)
|
4
12
|
|
5
13
|
|
data/CONTRIBUTING.md
CHANGED
@@ -35,6 +35,64 @@ There is three step process for code or documentation changes:
|
|
35
35
|
|
36
36
|
Make your changes in a fork of the track_open_instances repository.
|
37
37
|
|
38
|
+
#### Conventional commits
|
39
|
+
|
40
|
+
All commits to this repository MUST follow [the conventional commits
|
41
|
+
specification](https://www.conventionalcommits.org/en/v1.0.0/#specification). This is
|
42
|
+
so that release versions can automatically be generated based on the commit messages.
|
43
|
+
The Continuous Integration workflow will fail if a commit message is not in this
|
44
|
+
format.
|
45
|
+
|
46
|
+
The format for a conventional commit message is:
|
47
|
+
|
48
|
+
```Text
|
49
|
+
<commit-type>[optional scope]: <description>
|
50
|
+
|
51
|
+
[optional body]
|
52
|
+
|
53
|
+
[optional footer(s)]
|
54
|
+
```
|
55
|
+
|
56
|
+
Where commit type is one of:
|
57
|
+
|
58
|
+
* `feat:` A new feature for the end-user.
|
59
|
+
* `fix:` A bug fix for the end-user.
|
60
|
+
* `build:` Changes that affect the build system or external dependencies (e.g.,
|
61
|
+
changes to npm, webpack, Docker configurations).
|
62
|
+
* `chore:` Routine tasks, maintenance, or changes that don't modify source code or
|
63
|
+
test files (e.g., updating dependencies, configuring linters).
|
64
|
+
* `docs:` Changes to documentation only (e.g., updating README, guides, or extensive
|
65
|
+
code comments).
|
66
|
+
* `style:` Changes that do not affect the meaning or logic of the code (e.g.,
|
67
|
+
white-space, formatting, fixing linter warnings, missing semi-colons).
|
68
|
+
* `refactor:` A code change that neither fixes a bug nor adds a feature, but improves
|
69
|
+
the code structure, readability, or organization without changing its external
|
70
|
+
behavior.
|
71
|
+
* `perf:` A code change that improves performance.
|
72
|
+
* `test:` Adding missing tests or correcting existing tests; changes to the test
|
73
|
+
environment or configuration.
|
74
|
+
|
75
|
+
Backward incompatible changes (aka breaking changes) should append a `!` after the
|
76
|
+
commit type or add the footer `BREAKING CHANGE:` as shown in the following examples:
|
77
|
+
|
78
|
+
```Text
|
79
|
+
fix!: change the interface to match the requirements
|
80
|
+
```
|
81
|
+
|
82
|
+
```Text
|
83
|
+
fix: change the interface to match the requirements
|
84
|
+
|
85
|
+
BREAKING CHANGE: users will need to add additional, non-default option
|
86
|
+
```
|
87
|
+
|
88
|
+
These commit messages will have the following impact on the release version number:
|
89
|
+
|
90
|
+
* Breaking changes (of any commit type) will bump the major version component
|
91
|
+
* `feat:` commits will bump the minor version component
|
92
|
+
* `fix:` commits will bump the patch version component
|
93
|
+
|
94
|
+
Any other commit types (that are not breaking changes) will not trigger a release.
|
95
|
+
|
38
96
|
### Create a pull request
|
39
97
|
|
40
98
|
See [this article](https://help.github.com/articles/about-pull-requests/) if you
|
@@ -62,12 +120,38 @@ request meets [the project's coding standards](#coding-standards).
|
|
62
120
|
|
63
121
|
All pull requests must meet these requirements:
|
64
122
|
|
65
|
-
###
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
123
|
+
### Rebase Merge Strategy
|
124
|
+
|
125
|
+
Our project requires a linear commit history, which is achieved by using a
|
126
|
+
rebase strategy to enable fast-forward merges for all Pull Requests (PRs).
|
127
|
+
|
128
|
+
* **Goal:** To integrate PRs without creating extra merge commits, ensuring a clean
|
129
|
+
and linear project history. This requires the PR branch to be eligible for a
|
130
|
+
[fast-forward
|
131
|
+
merge](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging).
|
132
|
+
* **Commit History:** Before merging, clean up your PR's commit history. Squash
|
133
|
+
related changes into logical commits using interactive rebase (`git rebase -i`).
|
134
|
+
Aim for a minimal number of meaningful commits that represent distinct steps or
|
135
|
+
features.
|
136
|
+
* **Enable Fast-Forward:** To ensure a fast-forward merge is possible, you must
|
137
|
+
rebase your feature branch onto the latest version of the target branch (e.g.,
|
138
|
+
`main`) *before* the PR is merged.
|
139
|
+
* Example commands (assuming your remote is `origin` and the target branch is
|
140
|
+
`main`):
|
141
|
+
|
142
|
+
```bash
|
143
|
+
# Fetch the latest changes from the remote
|
144
|
+
git fetch origin
|
145
|
+
|
146
|
+
# Rebase your current branch onto the latest main branch
|
147
|
+
git rebase origin/main
|
148
|
+
```
|
149
|
+
|
150
|
+
* You may need to resolve conflicts during the rebase process. After successfully
|
151
|
+
rebasing, you'll likely need to force-push your branch (`git push
|
152
|
+
--force-with-lease`).
|
153
|
+
|
154
|
+
* You may need to rebase again if other PRs are merged to main.
|
71
155
|
|
72
156
|
### Unit tests
|
73
157
|
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: track_open_instances
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.12
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- James Couball
|
@@ -218,8 +218,8 @@ metadata:
|
|
218
218
|
allowed_push_host: https://rubygems.org
|
219
219
|
homepage_uri: https://github.com/main-branch/track_open_instances
|
220
220
|
source_code_uri: https://github.com/main-branch/track_open_instances
|
221
|
-
documentation_uri: https://rubydoc.info/gems/track_open_instances/0.1.
|
222
|
-
changelog_uri: https://rubydoc.info/gems/track_open_instances/0.1.
|
221
|
+
documentation_uri: https://rubydoc.info/gems/track_open_instances/0.1.12
|
222
|
+
changelog_uri: https://rubydoc.info/gems/track_open_instances/0.1.12/file/CHANGELOG.md
|
223
223
|
rubygems_mfa_required: 'true'
|
224
224
|
rdoc_options: []
|
225
225
|
require_paths:
|