revert: deprecate include-pre-releases (#1523)

Partly reverts commit cfec7ce

Author: cchanche

README.md

@@ -141,6 +141,7 @@ You can configure Release Drafter using the following key in your `.github/relea
 | `sort-direction`           | Optional | Sort changelog in ascending or descending order. Can be one of: `ascending`, `descending`. Default: `descending`.                                                                  |
 | `prerelease`               | Optional | Whether to draft a prerelease, with changes since another prerelease (if applicable). Default `false`.                                                                             |
 | `prerelease-identifier`    | Optional | A string indicating an identifier (alpha, beta, rc, etc), to increment the prerelease version. This automatically enables `prerelease` if not already set to `true`. Default `''`. |
+| `include-pre-releases`     | Optional | When looking for the last published release to scan changes up-to, include pre-releases. Has no effect if using `prerelease: true` (already enabled). Default `false`.             |
 | `latest`                   | Optional | Mark the release as latest. Only works for published releases. Can be one of: `true`, `false`, `legacy`. Default `true`.                                                           |
 | `version-resolver`         | Optional | Adjust the `$RESOLVED_VERSION` variable using labels. Refer to [Version Resolver](#version-resolver) to learn more about this                                                      |
 | `commitish`                | Optional | The release target, i.e. branch or commit it should point to. Default: the ref that release-drafter runs for, e.g. `refs/heads/master` if configured to run on pushes to `master`. |
@@ -386,10 +387,11 @@ Some users like to run `update_prerelease_draft` with `publish: true`, such as p
 
 > [!IMPORTANT]
 >
-> - The `include-pre-releases` config was deprecated in `v6.3.0`. See [#1515](https://github.com/release-drafter/release-drafter/pull/1515)
 > - `prerelease-identifier` is not required when `prerelease` is enabled, but your prerelease will be named after / be associated with a tag that is not semver-compliant to actual prereleases.
 > - when specified `prerelease-identifier` enables `prerelease: true`
 
+If you want your stable releases to include changes since the last prerelease instead of the last stable release use `include-pre-releases: true`. This can reduce the number of changes included in the stable release body, but diverges from the standard workflow depicted above.
+
 ## Projects that don't use Semantic Versioning
 
 If your project doesn't follow [Semantic Versioning](https://semver.org) you can still use Release Drafter, but you may want to set the `version-template` option to customize how the `$NEXT_{PATCH,MINOR,MAJOR}_VERSION` environment variables are generated.

dist/index.js

@@ -190076,6 +190076,9 @@ const { paginate } = __nccwpck_require__(50345)
 const Joi = __nccwpck_require__(81154)
 const core = __nccwpck_require__(37484)
 
+/**
+ * @see https://docs.github.com/en/graphql/reference/objects#commit
+ */
 const findCommitsWithPathChangesQuery = /* GraphQL */ `
   query findCommitsWithPathChangesQuery(
     $name: String!
@@ -190536,6 +190539,14 @@ const sortReleases = (releases, tagPrefix) => {
 // GitHub API currently returns a 500 HTTP response if you attempt to fetch over 1000 releases.
 const RELEASE_COUNT_LIMIT = 1000
 
+/**
+ * Find previous releases in the repo
+ *
+ * The last stable release is used to determine the range of commits to include in the changelog,
+ * and to resolve the next version number.
+ *
+ * The draft release is used to determine if we should create a new release or update the existing one.
+ */
 const findReleases = async ({
   context,
   targetCommitish,
@@ -190585,7 +190596,7 @@ const findReleases = async ({
   // Handle prereleases
   publishedReleases = publishedReleases.filter(
     (publishedRelease) =>
-      isPreRelease || includePreReleases // `includePreReleases` will be removed in future versions
+      isPreRelease || includePreReleases
         ? publishedRelease.prerelease || !publishedRelease.prerelease // Both prerelease and regular published-releases
         : !publishedRelease.prerelease // Only regular published-releases
   )
@@ -191327,12 +191338,6 @@ const validateSchema = (context, repoConfig) => {
     config.autolabeler = []
   }
 
-  if (config['include-pre-releases']) {
-    context.log.info(
-      "'include-pre-releases' will be deprecated in next version. Use 'prerelease: true' instead. See PR #1515 for more"
-    )
-  }
-
   return config
 }
 

lib/commits.js

@@ -4,6 +4,9 @@ const { paginate } = require('./pagination')
 const Joi = require('joi')
 const core = require('@actions/core')
 
+/**
+ * @see https://docs.github.com/en/graphql/reference/objects#commit
+ */
 const findCommitsWithPathChangesQuery = /* GraphQL */ `
   query findCommitsWithPathChangesQuery(
     $name: String!

lib/releases.js

@@ -24,6 +24,14 @@ const sortReleases = (releases, tagPrefix) => {
 // GitHub API currently returns a 500 HTTP response if you attempt to fetch over 1000 releases.
 const RELEASE_COUNT_LIMIT = 1000
 
+/**
+ * Find previous releases in the repo
+ *
+ * The last stable release is used to determine the range of commits to include in the changelog,
+ * and to resolve the next version number.
+ *
+ * The draft release is used to determine if we should create a new release or update the existing one.
+ */
 const findReleases = async ({
   context,
   targetCommitish,
@@ -73,7 +81,7 @@ const findReleases = async ({
   // Handle prereleases
   publishedReleases = publishedReleases.filter(
     (publishedRelease) =>
-      isPreRelease || includePreReleases // `includePreReleases` will be removed in future versions
+      isPreRelease || includePreReleases
         ? publishedRelease.prerelease || !publishedRelease.prerelease // Both prerelease and regular published-releases
         : !publishedRelease.prerelease // Only regular published-releases
   )

lib/schema.js

@@ -223,12 +223,6 @@ const validateSchema = (context, repoConfig) => {
     config.autolabeler = []
   }
 
-  if (config['include-pre-releases']) {
-    context.log.info(
-      "'include-pre-releases' will be deprecated in next version. Use 'prerelease: true' instead. See PR #1515 for more"
-    )
-  }
-
   return config
 }