Skip to content

Commit 161093d

Browse files
author
IvanZosimov
committed
Update the repo to the standards of maintaining team
In scope of this commit issues and PR temlates were updated, some workflows were renamed and partly updated, some workflows such as release-new-action-version.yml and licensed.yml were added. The stale.yml workflow was deleted as it was considered as harmful and inconvenient.
1 parent 65b52af commit 161093d

12 files changed

+146
-110
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report
4+
title: ''
5+
labels: bug, needs triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
11+
<!--- Before opening up a new bug report, please make sure to check for similar existing issues -->
12+
13+
**Description:**
14+
A clear and concise description of what the bug is.
15+
16+
**Action version:**
17+
Specify the task version
18+
19+
**Platform:**
20+
- [ ] Ubuntu
21+
- [ ] macOS
22+
- [ ] Windows
23+
24+
**Runner type:**
25+
- [ ] Hosted
26+
- [ ] Self-hosted
27+
28+
**Repro steps:**
29+
A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link.
30+
31+
**Expected behavior:**
32+
A description of what you expected to happen.
33+
34+
**Actual behavior:**
35+
A description of what is actually happening.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: false
Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
---
22
name: Feature request
3-
about: Propose a new feature or an enhancement
3+
about: Suggest an idea for this project
44
title: ''
5-
labels: enhancement
5+
labels: feature request, needs triage
66
assignees: ''
77
---
88

9-
## The problem
9+
<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
10+
<!--- Before opening up a new bug report, please make sure to check for similar existing issues -->
1011

11-
## The solution
12+
**Description:**
13+
Describe your proposal.
14+
15+
**Justification:**
16+
Justification or a use case for your proposal.
17+
18+
**Are you willing to submit a PR?**
19+
<!--- We accept contributions! -->

.github/ISSUE_TEMPLATE/other_issue_report.md

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

.github/ISSUE_TEMPLATE/stale_issue_report.md

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

.github/pull_request_template.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
<!-- List the change(s) you're making with this PR. -->
1+
**Description:**
2+
Describe your changes.
23

3-
## Changes
4+
**Related issue:**
5+
Add link to the related issue.
46

5-
- [x] ...
6-
7-
## Context
8-
9-
<!-- Explain why you're making the change(s). -->
10-
<!-- If you're closing an issue with this PR, [link them with a keyword](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). -->
7+
**Check list:**
8+
- [ ] Mark if documentation changes are required.
9+
- [ ] Mark if tests were added or updated to cover the changes.

.github/workflows/build-test.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Build & Test
2+
on:
3+
pull_request:
4+
paths-ignore:
5+
- '**.md'
6+
push:
7+
branches:
8+
- main
9+
- releases/*
10+
paths-ignore:
11+
- '**.md'
12+
13+
jobs:
14+
build:
15+
runs-on: ${{ matrix.operating-system }}
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
operating-system: [ubuntu-latest, windows-latest, macOS-latest]
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v3
23+
24+
- name: Set Node.js 16
25+
uses: actions/setup-node@v3
26+
with:
27+
node-version: 16.x
28+
cache: npm
29+
30+
- name: Install dependencies
31+
run: npm ci --ignore-scripts
32+
33+
- name: Format, lint, build and test
34+
run: npm run all:ci
35+
36+
dry-run-test: # make sure the action works on a clean machine without building
37+
runs-on: ubuntu-latest
38+
steps:
39+
- uses: actions/checkout@v3
40+
- uses: ./
41+
id: stale
42+
with:
43+
stale-issue-message: 'This issue is stale'
44+
stale-pr-message: 'This PR is stale'
45+
debug-only: true
46+
- name: Print outputs
47+
run: echo ${{ join(steps.stale.outputs.*, ',') }}

.github/workflows/codeql.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ name: 'Code scanning'
22

33
on:
44
push:
5-
branches:
6-
- main
5+
branches: [ main ]
76
pull_request:
7+
branches: [ main ]
88
schedule:
9-
- cron: '0 19 * * 0'
9+
- cron: '23 19 * * 0'
1010

1111
jobs:
1212
CodeQL-Build:
@@ -17,6 +17,8 @@ jobs:
1717

1818
- name: Initialize CodeQL
1919
uses: github/codeql-action/init@v2
20+
with:
21+
languages: "javascript"
2022

2123
- name: Autobuild
2224
uses: github/codeql-action/autobuild@v2
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
name: Licensed
22

33
on:
4-
push: {branches: main}
5-
pull_request: {branches: main}
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
workflow_dispatch:
611

712
jobs:
813
test:
914
runs-on: ubuntu-latest
1015
name: Check licenses
1116
steps:
12-
- uses: actions/checkout@v2
13-
- run: npm ci
17+
- uses: actions/checkout@v3
18+
- run: npm ci --ignore-scripts
1419
- name: Install licensed
1520
run: |
1621
cd $RUNNER_TEMP
17-
curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.12.2/licensed-2.12.2-linux-x64.tar.gz
22+
curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.9.0/licensed-3.9.0-linux-x64.tar.gz
1823
sudo tar -xzf licensed.tar.gz
1924
sudo mv licensed /usr/local/bin/licensed
20-
- run: licensed status
25+
- run: licensed status
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Release new action version
2+
on:
3+
release:
4+
types: [released]
5+
workflow_dispatch:
6+
inputs:
7+
TAG_NAME:
8+
description: 'Tag name that the major tag will point to'
9+
required: true
10+
11+
env:
12+
TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
13+
permissions:
14+
contents: write
15+
16+
jobs:
17+
update_tag:
18+
name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
19+
environment:
20+
name: releaseNewActionVersion
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Update the ${{ env.TAG_NAME }} tag
24+
id: update-major-tag
25+
uses: actions/[email protected]
26+
with:
27+
source-tag: ${{ env.TAG_NAME }}
28+
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/stale.yml

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

.github/workflows/test.yml

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

0 commit comments

Comments
 (0)