Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add GitHub templates and workflows #8

Merged
merged 4 commits into from
Jan 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @cloudscape-design/cloudscape-dev
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug Report
description: Report a bug
title: "[Bug]: "
labels: bug
body:
- type: markdown
attributes:
value: Provide as much information as possible to help us investigate the bug.
- type: dropdown
id: browser
attributes:
label: Browser
description: In which browser(s) are you experiencing the issue?
multiple: true
options:
- Chrome
- Safari
- Firefox
- Edge
- type: input
id: version
attributes:
label: Package version
description: Which version(s) are you using?
placeholder: e.g. v3.0.122
validations:
required: true
- type: input
id: react-version
attributes:
label: React version
description: Which version of React are you using?
placeholder: e.g. v18.0.1
- type: textarea
id: description
attributes:
label: Description
description: Tell us more about the issue you are experiencing
placeholder: What is the actual and expected behavior?
validations:
required: true
- type: textarea
id: source-code
attributes:
label: Source code
description: Share links to your source code
- type: textarea
id: reproduction
attributes:
label: Reproduction
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
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: Please confirm the following
options:
- label: I agree to follow this project's [Code of
Conduct](https://github.com/cloudscape-design/components/blob/main/CODE_OF_CONDUCT.md)
required: true
- label: I checked the current issues on [this](https://github.com/cloudscape-design/code-view/issues) and
[main](https://github.com/cloudscape-design/components/issues) repositories for duplicate problems
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Feature request
description: Request a feature
title: "[Feature Request]: "
labels: enhancement
body:
- type: markdown
attributes:
value: Use this template to request a new feature.
- type: textarea
id: description
attributes:
label: Description
description: Describe the feature you request. Provide details on your use case, and how it would benefit your customers
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: Please confirm the following
options:
- label: I agree to follow this project's [Code of
Conduct](https://github.com/cloudscape-design/components/blob/main/CODE_OF_CONDUCT.md)
required: true
- label:
I checked the current issues on [this](https://github.com/cloudscape-design/code-view/issues) and
[main](https://github.com/cloudscape-design/components/issues) repositories for duplicate requests
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/cloudscape-design/components/discussions
about: Ask a question about Cloudscape Design System
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
### Description

<!-- Include a summary of the changes and the related issue. -->

<!-- Also include relevant motivation and context. -->

Related links, issue #, if available: n/a

### How has this been tested?

<!-- How did you test to verify your changes? -->

<!-- How can reviewers test these changes efficiently? -->

<details>
<summary>Review checklist</summary>

_The following items are to be evaluated by the author(s) and the reviewer(s)._

#### Correctness

- _Changes include appropriate documentation updates._
- _Changes are backward-compatible if not indicated, see [`CONTRIBUTING.md`](https://github.com/cloudscape-design/components/blob/main/CONTRIBUTING.md#public-apis)._
- _Changes do not include unsupported browser features, see [`CONTRIBUTING.md`](https://github.com/cloudscape-design/components/blob/main/CONTRIBUTING.md#browsers-support)._
- _Changes were manually tested for accessibility, see [accessibility guidelines](https://cloudscape.design/foundation/core-principles/accessibility/)._

#### Testing

- _Changes are covered with new/existing unit tests?_
- _Changes are covered with new/existing integration tests?_
</details>

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
30 changes: 30 additions & 0 deletions .github/workflows/build-lint-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Build, lint and test

on:
pull_request:
branches:
- main
push:
branches:
- main

permissions:
id-token: write
actions: read
contents: read
security-events: write
deployments: write

jobs:
build:
uses: cloudscape-design/actions/.github/workflows/build-lint-test.yml@main
with:
artifact-path: dist
artifact-name: dev-pages
deploy:
needs: build
uses: cloudscape-design/actions/.github/workflows/deploy.yml@main
secrets: inherit
with:
artifact-name: dev-pages
deployment-path: dist
timogasda marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 12 additions & 0 deletions .github/workflows/dry-run.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This workflow executes a full dry-run test, which means that all we build and test all @cloudscape-design packages in GitHub.
# This ensures that the changes in the current package do not cause any regressions for its consumers.
name: Dry-run
on:
workflow_dispatch:
pull_request:
branches:
- main

jobs:
dry-run:
uses: cloudscape-design/actions/.github/workflows/dry-run.yml@main
12 changes: 12 additions & 0 deletions .github/workflows/lint-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Lint PR

on:
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
dry-run:
uses: cloudscape-design/actions/.github/workflows/lint-pr.yml@main
18 changes: 18 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# This workflow releases the current package to a dedicated private CodeArtifact repository.
# One repository may publish more than one package. For more details refer to the release-package Action.
name: Release

on:
push:
branches:
- main
- "dev-v3-*"

permissions:
id-token: write
contents: read

jobs:
release:
uses: cloudscape-design/actions/.github/workflows/release.yml@main
secrets: inherit
Loading