Skip to content

Commit 3da763a

Browse files
committed
Bug fixes.
1 parent a1226a1 commit 3da763a

File tree

7 files changed

+35
-133
lines changed

7 files changed

+35
-133
lines changed

.github/workflows/check_pr_release_notes.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
# limitations under the License.
1515
#
1616

17+
# GH workflow example from https://github.com/AbsaOSS/generate-release-notes/blob/master/examples/check_pr_release_notes.yml
1718
name: Check PR Release Notes in Description
1819

1920
on:

.github/workflows/release_draft.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright 2023 ABSA Group Limited
2+
# Copyright 2024 ABSA Group Limited
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
@@ -14,6 +14,7 @@
1414
# limitations under the License.
1515
#
1616

17+
# GH workflow example from https://github.com/AbsaOSS/generate-release-notes/blob/master/examples/release_draft.yml
1718
name: Release - create draft release
1819
on:
1920
workflow_dispatch:

.github/workflows/release_notes_comments_migration.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
#
2+
# Copyright 2024 ABSA Group Limited
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
117
name: Copy Release Notes to Related Issues
218

319
on:

.github/workflows/static_analysis_and_tests.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
#
2+
# Copyright 2024 ABSA Group Limited
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
117
name: "Static analysis & tests"
218

319
on:

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@
2828
- [Living Documentation Page Generation](#living-documentation-page-generation)
2929
- [Structured Output](#structured-output)
3030
- [Output Grouped by Topics](#output-grouped-by-topics)
31-
- [GitHub Workflow Examples](#github-workflow-examples)
32-
- [Create Release Tag & Draft Release - By Workflow Dispatch](#create-release-tag--draft-release---by-workflow-dispatch)
33-
- [Check Release Notes Presence - in Pull Request Description](#check-release-notes-presence---in-pull-request-description)
3431
- [Contribution Guidelines](#contribution-guidelines)
3532
- [License Information](#license-information)
3633
- [Contact or Support Information](#contact-or-support-information)
@@ -653,20 +650,6 @@ To gain a better understanding of the term "Topic", refer to the [Labels](#label
653650

654651
---
655652

656-
## GitHub Workflow Examples
657-
GitHub Actions enable automating key parts of your development process.
658-
659-
### Create Release Tag & Draft Release - By Workflow Dispatch
660-
This workflow automates the creation of a release tag and a draft release, triggered manually via a workflow dispatch.
661-
Tag is created after successful release notes generation to avoid manual removing of the tag if the release notes are not generated due to wrong configuration.
662-
663-
See the [example of workflow](./examples/release_draft.yml).
664-
665-
### Check Release Notes Presence - in Pull Request Description
666-
This workflow checks that every pull request includes release notes in the PR description.
667-
668-
See the [example of workflow](./examples/check_pr_release_notes.yml).
669-
670653
## Contribution Guidelines
671654

672655
We welcome contributions to the Living Documentation Generator! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.

examples/check_pr_release_notes.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

examples/release_draft.yml

Lines changed: 0 additions & 88 deletions
This file was deleted.

0 commit comments

Comments
 (0)