Skip to content

Commit 300f1d1

Browse files
authored
Refactor: PR template, issues template and workflow for main (#190)
* refactor: update the PR template, issues template and workflow for `main` * chore: update the build script for main
1 parent 7e84271 commit 300f1d1

File tree

4 files changed

+17
-24
lines changed

4 files changed

+17
-24
lines changed
File renamed without changes.

.github/PULL_REQUEST_TEMPLATE/feature.md

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Fix:
21
closes #
32

4-
Issue(s):
5-
Describe what the bug was.
3+
Description:
4+
Describe what the bug was or what the feature is.
65
e.g. On the README page, the typed in message "Computing Science Student Society" was wrapping on letters rather than words.
76

7+
# FOR BUGS
88
Root cause:
99
Explain the root cause of the issue.
1010
e.g. Since the animation used GSAP's split by chars feature, each individual letter was its own inline-block, which means word wrapping wouldn't work since they were all separate divs.
@@ -13,6 +13,12 @@ Fix:
1313
Describe your solution.
1414
e.g. Added reverted the letters back to a single div using `split.revert()` once the animation has completed.
1515

16+
# FOR FEATURES
17+
Features:
18+
* Create a list of features that were added
19+
* These features should explain workflows for end user, how to access the feature, and any requirements the end user should know
20+
* If you developed a new module/framework for developers, mention it here too
21+
1622
(optional) Future issues:
17-
If you foresee your fix causing an issue in the future mention it here.
23+
If you foresee your change causing an issue in the future then mention it here.
1824
If it's something we'll need to address then we can open another issue to address this one.

.github/workflows/deploy-to-branch.yml renamed to .github/workflows/deploy-to-build.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,31 @@ jobs:
2020
with:
2121
node-version: '22.x'
2222
- run: npm ci
23-
- run: npm run build --if-present
23+
- run: npm run build
2424

2525
- name: Preserve build output when moving branches
26-
run: mv build ../build-tmp
26+
# If this is not done then the build folder will be lost when we switch branches
27+
run: mv dist/csss-ng-frontend/browser ../build-tmp
2728

2829
- name: Switch to the build branch and clean it
2930
run: |
30-
# Based off the script `./scripts/deploy_to_branch.sh`
31-
# The branch we are publishing to
31+
# Get the latest on the branch that builds are held in and switch to it
3232
git fetch origin build
3333
git switch build
34+
# Remove everything in order to copy everything over
3435
rm -rf *
3536
3637
- name: Copy the built files over to the root directory and push to `build`
3738
run: |
38-
# Set up a dummy user and email for identification purposes
3939
cp -R ../build-tmp/* .
40-
rm -f ./js/*.LICENSE.txt
4140
4241
- name: Commit and push
4342
run: |
43+
# Set up a dummy user and email for identification purposes
4444
git config --global user.name "${{ github.actor }}"
4545
git config --global user.email "${{ github.actor }}@user.noreply.github.com"
4646
git add .
47-
git commit -m "Updating `build` with PR#${{ github.event.pull_request.number }}: ${{ github.event.pull_request.title }}"
47+
git commit -m "${{ github.event.pull_request.title }}"
4848
git push origin build
4949
env:
5050
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)