Skip to content

Commit 9e033f6

Browse files
author
Rúben Carvalho
authored
feat: Add GitHub templates and workflows (#8)
* feat: Add GitHub templates and workflows
1 parent 561637f commit 9e033f6

File tree

9 files changed

+202
-0
lines changed

9 files changed

+202
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @cloudscape-design/cloudscape-dev

‎.github/ISSUE_TEMPLATE/1_bug_report.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug Report
2+
description: Report a bug
3+
title: "[Bug]: "
4+
labels: bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Provide as much information as possible to help us investigate the bug.
9+
- type: dropdown
10+
id: browser
11+
attributes:
12+
label: Browser
13+
description: In which browser(s) are you experiencing the issue?
14+
multiple: true
15+
options:
16+
- Chrome
17+
- Safari
18+
- Firefox
19+
- Edge
20+
- type: input
21+
id: version
22+
attributes:
23+
label: Package version
24+
description: Which version(s) are you using?
25+
placeholder: e.g. v3.0.122
26+
validations:
27+
required: true
28+
- type: input
29+
id: react-version
30+
attributes:
31+
label: React version
32+
description: Which version of React are you using?
33+
placeholder: e.g. v18.0.1
34+
- type: textarea
35+
id: description
36+
attributes:
37+
label: Description
38+
description: Tell us more about the issue you are experiencing
39+
placeholder: What is the actual and expected behavior?
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: source-code
44+
attributes:
45+
label: Source code
46+
description: Share links to your source code
47+
- type: textarea
48+
id: reproduction
49+
attributes:
50+
label: Reproduction
51+
description: Recreate the issue using [CodeSandbox](https://codesandbox.io/). Use this [template](https://codesandbox.io/s/cloudscape-design-system-react-javascript-ljs1t7) as a starting point
52+
- type: checkboxes
53+
id: terms
54+
attributes:
55+
label: Code of Conduct
56+
description: Please confirm the following
57+
options:
58+
- label: I agree to follow this project's [Code of
59+
Conduct](https://github.com/cloudscape-design/components/blob/main/CODE_OF_CONDUCT.md)
60+
required: true
61+
- label: I checked the current issues on [this](https://github.com/cloudscape-design/code-view/issues) and
62+
[main](https://github.com/cloudscape-design/components/issues) repositories for duplicate problems

‎.github/ISSUE_TEMPLATE/2_feature_request.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature request
2+
description: Request a feature
3+
title: "[Feature Request]: "
4+
labels: enhancement
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Use this template to request a new feature.
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: Describe the feature you request. Provide details on your use case, and how it would benefit your customers
14+
validations:
15+
required: true
16+
- type: checkboxes
17+
id: terms
18+
attributes:
19+
label: Code of Conduct
20+
description: Please confirm the following
21+
options:
22+
- label: I agree to follow this project's [Code of
23+
Conduct](https://github.com/cloudscape-design/components/blob/main/CODE_OF_CONDUCT.md)
24+
required: true
25+
- label:
26+
I checked the current issues on [this](https://github.com/cloudscape-design/code-view/issues) and
27+
[main](https://github.com/cloudscape-design/components/issues) repositories for duplicate requests

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/cloudscape-design/components/discussions
5+
about: Ask a question about Cloudscape Design System

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
### Description
2+
3+
<!-- Include a summary of the changes and the related issue. -->
4+
5+
<!-- Also include relevant motivation and context. -->
6+
7+
Related links, issue #, if available: n/a
8+
9+
### How has this been tested?
10+
11+
<!-- How did you test to verify your changes? -->
12+
13+
<!-- How can reviewers test these changes efficiently? -->
14+
15+
<details>
16+
<summary>Review checklist</summary>
17+
18+
_The following items are to be evaluated by the author(s) and the reviewer(s)._
19+
20+
#### Correctness
21+
22+
- _Changes include appropriate documentation updates._
23+
- _Changes are backward-compatible if not indicated, see [`CONTRIBUTING.md`](https://github.com/cloudscape-design/components/blob/main/CONTRIBUTING.md#public-apis)._
24+
- _Changes do not include unsupported browser features, see [`CONTRIBUTING.md`](https://github.com/cloudscape-design/components/blob/main/CONTRIBUTING.md#browsers-support)._
25+
- _Changes were manually tested for accessibility, see [accessibility guidelines](https://cloudscape.design/foundation/core-principles/accessibility/)._
26+
27+
#### Testing
28+
29+
- _Changes are covered with new/existing unit tests?_
30+
- _Changes are covered with new/existing integration tests?_
31+
</details>
32+
33+
---
34+
35+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

‎.github/workflows/build-lint-test.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Build, lint and test
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
push:
8+
branches:
9+
- main
10+
11+
permissions:
12+
id-token: write
13+
actions: read
14+
contents: read
15+
security-events: write
16+
deployments: write
17+
18+
jobs:
19+
build:
20+
uses: cloudscape-design/actions/.github/workflows/build-lint-test.yml@main
21+
with:
22+
artifact-path: dist
23+
artifact-name: dev-pages
24+
deploy:
25+
needs: build
26+
uses: cloudscape-design/actions/.github/workflows/deploy.yml@main
27+
secrets: inherit
28+
with:
29+
artifact-name: dev-pages
30+
deployment-path: dist

‎.github/workflows/dry-run.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# This workflow executes a full dry-run test, which means that all we build and test all @cloudscape-design packages in GitHub.
2+
# This ensures that the changes in the current package do not cause any regressions for its consumers.
3+
name: Dry-run
4+
on:
5+
workflow_dispatch:
6+
pull_request:
7+
branches:
8+
- main
9+
10+
jobs:
11+
dry-run:
12+
uses: cloudscape-design/actions/.github/workflows/dry-run.yml@main

‎.github/workflows/lint-pr.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Lint PR
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
jobs:
11+
dry-run:
12+
uses: cloudscape-design/actions/.github/workflows/lint-pr.yml@main

‎.github/workflows/release.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# This workflow releases the current package to a dedicated private CodeArtifact repository.
2+
# One repository may publish more than one package. For more details refer to the release-package Action.
3+
name: Release
4+
5+
on:
6+
push:
7+
branches:
8+
- main
9+
- "dev-v3-*"
10+
11+
permissions:
12+
id-token: write
13+
contents: read
14+
15+
jobs:
16+
release:
17+
uses: cloudscape-design/actions/.github/workflows/release.yml@main
18+
secrets: inherit

0 commit comments

Comments
 (0)