From 46e1b8c8292cc7e5691f9e65fe359e8997fec47f Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Thu, 5 Aug 2021 08:01:07 +0200 Subject: [PATCH] Prepare Changelog and wiki for v2.3.1 release (#91) * Prepare Changelog and wiki for v2.3.1 release * Update Configuration.md * Update Configuration.md * Fix missing description --- CHANGELOG.md | 9 ++++ docs/Configuration.md | 109 ++++++++++++++++++++++-------------------- 2 files changed, 65 insertions(+), 53 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 78690598c5..24418fd02a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,15 @@ Note that the displayed date is in the format `dd-mm-yyyy` [Older changelogs](#older-changelogs) +## [v2.3.1] +> **Released:** `{TBA}` + +### Added Features +- Added `{AMOUNT}` placeholder for `changes_requested` message. [#90] + +[v2.3.1]: https://github.com/Readme-Workflows/recent-activity/releases/tag/v2.3.1 +[#90]: https://github.com/Readme-Workflows/recent-activity/pull/90 + ## [v2.3.0] > **Released:** `02-07-2021` diff --git a/docs/Configuration.md b/docs/Configuration.md index 1027f3d6a5..d73fe51a20 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -64,6 +64,7 @@ The config file is split into two major sections: [Settings](#settings) and [Mes Every option in the file is **optional** and will default to a specific value (See `Default` section for what) +---- ### Settings The `Settings` area contains various settings to configure. @@ -194,144 +195,146 @@ Supported are all options mentioned in the [dateformat NPM package][dateformat]. Note that the `Z` cannot display the actual timezone such as `CET`/`CEST` but only timezones within the US (`EST`/`MDT`) or `GMT` with the offset appended to it (i.e. `GMT+0100`). +---- ### Messages The `messages` section contains all the different messages you can set for the Activity-List to display. **Notes about Placeholders:** - Available Placeholders are: `{DATE}`, `{ID}`, `{FORK}`, `{REPO}`, `{URL}` and `{WIKI}` - Each option only supports specific Placeholders which are mentioned in the `Supported Placeholders` section. -- With the exception of `{DATE}` and `{WIKI}` will all placeholders be turned into embedded links (i.e. `{ID}` becomes `[#1](:url)`) - - `{ID}` and `{REPO}` can be used in [`url_text`](#url_text) and won't be turned into embedded links. `{ID}` will still be prefixed with a `#` +- With the exception of `{AMOUNT}`, `{DATE}` and `{WIKI}` will all placeholders be turned into embedded links (i.e. `{ID}` becomes `[#1](:url)`) + - `{ID}` and `{REPO}` can be used in [`url_text`](#url_text) and won't be turned into embedded links there. `{ID}` will still be prefixed with a `#` - -#### `comments` -> **Default:** `💬 Commented on {ID} in {REPO}` +#### `added_member` +> **Default:** `🤝 Became collaborator on {REPO}` > > **Supported Placeholders:** -> - `{ID}` > - `{REPO}` -> - [`{URL}`](#url_text) -This text is displayed whenever you commented on an issue, Pull request (Includes default Review comments but not actual [change requests](#changes_requested) or [approvals](#review_approved)) or commit. +This text is displayed whenever you get added as a Member/Collaborator to a Repository. -#### `issue_opened` -> **Default:** `❗️ Opened issue {ID} in {REPO}` +#### `changes_approved` +> **Default:** `👍 Approved {ID} in {REPO}` > > **Supported Placeholders:** > - `{ID}` > - `{REPO}` > - [`{URL}`](#url_text) -This text is displayed whenever you open a new Issue. +This text is displayed whenever you approve changes in a Pull request. -#### `issue_closed` -> **Default:** `✔️ Closed issue {ID} in {REPO}` +#### `changes_requested` +> **Default:** `🔴 Requested {AMOUNT} change(s) in {ID} in {REPO}` > > **Supported Placeholders:** > - `{ID}` > - `{REPO}` +> - `{AMOUNT}` > - [`{URL}`](#url_text) -This text is displayed whenever you close an issue. +This text is displayed whenever you request changes to a Pull request. +The action will combine multiple Change requests for the same Pull request into one. The `{AMOUNT}` placeholder can be used to display the amount of changes requested for a Pull request. -#### `pr_opened` -> **Default:** `💪 Opened PR {ID} in {REPO}` +#### `comments` +> **Default:** `💬 Commented on {ID} in {REPO}` > > **Supported Placeholders:** > - `{ID}` > - `{REPO}` > - [`{URL}`](#url_text) -This text is displayed whenever you open a new Pull request. +This text is displayed whenever you commented on an issue, Pull request (Includes default Review comments but not actual [change requests](#changes_requested) or [approvals](#review_approved)) or commit. -#### `pr_closed` -> **Default:** `❌ Closed PR {ID} in {REPO}` +#### `create_repo` +> **Default:** `📔 Created new repository {REPO}` > > **Supported Placeholders:** -> - `{ID}` > - `{REPO}` -> - [`{URL}`](#url_text) -This text is displayed whenever you close a Pull request without merging it. +This text is displayed whenever you create a new Repository. -#### `pr_merged` -> **Default:** `🎉 Merged PR {ID} in {REPO}` +#### `fork_repo` +> **Default:** `🔱 Forked {FORK} from {REPO}` > > **Supported Placeholders:** -> - `{ID}` +> - `{FORK}` > - `{REPO}` -> - [`{URL}`](#url_text) -This text is displayed whenever you merge a Pull request. +This text is displayed whenever you fork a Repository. -#### `create_repo` -> **Default:** `📔 Created new repository {REPO}` +#### `issue_opened` +> **Default:** `❗️ Opened issue {ID} in {REPO}` > > **Supported Placeholders:** +> - `{ID}` > - `{REPO}` +> - [`{URL}`](#url_text) -This text is displayed whenever you create a new Repository. +This text is displayed whenever you open a new Issue. -#### `fork_repo` -> **Default:** `🔱 Forked {FORK} from {REPO}` +#### `issue_closed` +> **Default:** `✔️ Closed issue {ID} in {REPO}` > > **Supported Placeholders:** -> - `{FORK}` +> - `{ID}` > - `{REPO}` +> - [`{URL}`](#url_text) -This text is displayed whenever you fork a Repository. +This text is displayed whenever you close an issue. -#### `wiki_create` -> **Default:** `📖 Created new wiki page {WIKI} in {REPO}` +#### `new_release` +> **Default:** `✌️ Released {ID} in {REPO}` > > **Supported Placeholders:** +> - `{ID}` > - `{REPO}` -> - `{WIKI}` +> - [`{URL}`](#url_text) -This text is displayed whenever you create a new Wiki page. `{WIKI}` will be the name of the Wiki page created. +This text is displayed whenever you create a new release. `{ID}` will represent the Tag of the release. -#### `added_member` -> **Default:** `🤝 Became collaborator on {REPO}` +#### `new_star` +> **Default:** `⭐ Starred {REPO}` > > **Supported Placeholders:** > - `{REPO}` -This text is displayed whenever you get added as a Member/Collaborator to a Repository. +This text is displayed whenever you star a Repository. -#### `changes_approved` -> **Default:** `👍 Approved {ID} in {REPO}` +#### `pr_opened` +> **Default:** `💪 Opened PR {ID} in {REPO}` > > **Supported Placeholders:** > - `{ID}` > - `{REPO}` > - [`{URL}`](#url_text) -This text is displayed whenever you approve changes in a Pull request. +This text is displayed whenever you open a new Pull request. -#### `changes_requested` -> **Default:** `🔴 Requested changes in {ID} in {REPO}` +#### `pr_closed` +> **Default:** `❌ Closed PR {ID} in {REPO}` > > **Supported Placeholders:** > - `{ID}` > - `{REPO}` > - [`{URL}`](#url_text) -This text is displayed whenever you request changes to a Pull request. +This text is displayed whenever you close a Pull request without merging it. -#### `new_release` -> **Default:** `✌️ Released {ID} in {REPO}` +#### `pr_merged` +> **Default:** `🎉 Merged PR {ID} in {REPO}` > > **Supported Placeholders:** > - `{ID}` > - `{REPO}` > - [`{URL}`](#url_text) -This text is displayed whenever you create a new release. `{ID}` will represent the Tag of the release. +This text is displayed whenever you merge a Pull request. -#### `new_star` -> **Default:** `⭐ Starred {REPO}` +#### `wiki_create` +> **Default:** `📖 Created new wiki page {WIKI} in {REPO}` > > **Supported Placeholders:** > - `{REPO}` +> - `{WIKI}` -This text is displayed whenever you star a Repository. +This text is displayed whenever you create a new Wiki page. `{WIKI}` will be the name of the Wiki page created.