release-please 15.10.1 → 15.10.3

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.10.3](https://github.com/googleapis/release-please/compare/v15.10.2...v15.10.3) (2023-04-11)
+
+
+### Bug Fixes
+
+* NeedsBootstrap computation also considers tags ([#1915](https://github.com/googleapis/release-please/issues/1915)) ([2773b6e](https://github.com/googleapis/release-please/commit/2773b6e8ae6bf7bd98adb89ed0eb702a1705b27b))
+
+## [15.10.2](https://github.com/googleapis/release-please/compare/v15.10.1...v15.10.2) (2023-04-11)
+
+
+### Bug Fixes
+
+* **github-changelog-notes:** Prepend header to create parseable release notes ([#1912](https://github.com/googleapis/release-please/issues/1912)) ([3f53d40](https://github.com/googleapis/release-please/commit/3f53d40c8c3f927fffdf8973128e12450703a6e4))
+
 ## [15.10.1](https://github.com/googleapis/release-please/compare/v15.10.0...v15.10.1) (2023-04-10)
 
 

package/README.md

@@ -52,6 +52,26 @@ The most important prefixes you should have in mind are:
 * `feat!:`,  or `fix!:`, `refactor!:`, etc., which represent a breaking change
   (indicated by the `!`) and will result in a SemVer major.
 
+### Linear git commit history (use squash-merge)
+
+We **highly** recommend that you use squash-merges when merging pull requests.
+A linear git history makes it much easier to:
+
+* Follow history - commits are sorted by merge date and are not mixed between
+  pull requests
+* Find and revert bugs - `git bisect` is helpful for tracking down which
+  change introduced a bug
+* Control the release-please changelog - when you merge a PR, you may have
+  commit messages that make sense within the scope of the PR, but don't
+  make sense when merged in the main branch. For example, you make have
+  `feat: introduce feature A` and then `fix: some bugfix introduced in
+  the first commit`. The `fix` commit is actually irrelevant to the release
+  notes as there was never a bug experienced in the main branch.
+* Keep a clean main branch - if you use something like red/green development
+  (create a failing test in commit A, then fix in commit B) and merge (or
+  rebase-merge), then there will be points in time in your main branch where
+  tests do not pass.
+
 ### What if my PR contains multiple fixes or features?
 
 Release Please allows you to represent multiple changes in a single commit,
@@ -79,7 +99,7 @@ The above commit message will contain:
   that it's a breaking change.
 3. an entry for the feature **"update encode to support unicode"**.
 
-> :warning: **Important:** The additional messages must be added to the bottom of the commit.
+:warning: **Important:** The additional messages must be added to the bottom of the commit.
 
 ## How do I change the version number?
 
@@ -113,6 +133,10 @@ END_COMMIT_OVERRIDE
 The next time Release Please runs, it will use that override section as the
 commit message instead of the merged commit message.
 
+:warning: **Important:** This feature will not work with plain merges because
+release-please does not know which commit(s) to apply the override to. [We
+recommend using squash-merge instead](#linear-git-commit-history-use-squash-merge).
+
 ## Release Please bot does not create a release PR. Why?
 
 Release Please creates a release pull request after it notices the default branch

package/build/src/changelog-notes/github.js

@@ -19,7 +19,10 @@ class GitHubChangelogNotes {
         this.github = github;
     }
     async buildNotes(_commits, options) {
-        return await this.github.generateReleaseNotes(options.currentTag, options.targetBranch, options.previousTag);
+        const body = await this.github.generateReleaseNotes(options.currentTag, options.targetBranch, options.previousTag);
+        const date = new Date().toLocaleDateString('en-CA');
+        const header = `## ${options.version} (${date})`;
+        return `${header}\n\n${body}`;
     }
 }
 exports.GitHubChangelogNotes = GitHubChangelogNotes;

package/build/src/manifest.js

@@ -225,7 +225,6 @@ class Manifest {
                 break;
             }
         }
-        const needsBootstrap = releasesFound < expectedReleases;
         if (releasesFound < expectedReleases) {
             this.logger.warn(`Expected ${expectedReleases} releases, only found ${releasesFound}`);
             // Fall back to looking for missing releases using expected tags
@@ -238,6 +237,7 @@ class Manifest {
                 releasesFound++;
             }
         }
+        const needsBootstrap = releasesFound < expectedReleases;
         if (releasesFound < expectedReleases) {
             this.logger.warn(`Expected ${expectedReleases} releases, only found ${releasesFound}`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "15.10.1",
+  "version": "15.10.3",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",