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(TA-471): add circle config #40

Merged
merged 27 commits into from
Feb 23, 2024
Merged

Conversation

darren-arbon
Copy link
Collaborator

@darren-arbon darren-arbon commented Feb 21, 2024

Problem

TA-471

Make this repo align with our other repos and use circle for stuff.

Change/Fix

This was the original config for github pages deploy

It has been changed to this

  1. Circle CI config set up to run 4 jobs
    a. Start
    b. Be Kind To Your Colleagues
    c. Lint and test
    This runs on all branch and main builds. Does the linting checks
    d. Push to Github Pages
    This only runs if the linting passes, and if the branch is main
  2. For circle to be able to run gh-pages which pushes to the gh-pages branch which is used in the above config, circle needed an SSH token that had write permissions, the default ones just have write, so an SSH key was made to work with this.

This has been tested and works fine.

Checklist

@@ -50,6 +50,6 @@
"severity": "warning"
}
],
"import-notation": "less"
"import-notation": "string"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whilst this was not causing failures in the linting, less was apparently not a valid value and was causing the npm test step to fail

"css-compile": "sass scss/:docs/assets/css/ --style=compressed --load-path=node_modules --source-map",
"css-lint": "stylelint scss/",
"format:stylelint": "stylelint scss/ --fix",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BW: re-ordered these in alpha

"css": "npm-run-all css-compile css-prefix",
"format:stylelint": "stylelint scss/ --fix",
"prepare": "husky install",
"publish:githubpages": "gh-pages --dist docs",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is new and needed for the circle config

@@ -46,6 +47,7 @@
"@commitlint/cli": "17.6.1",
"@commitlint/config-conventional": "17.6.1",
"autoprefixer": "10.4.14",
"gh-pages": "6.1.1",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This package allows us to do the release to github pages

@darren-arbon darren-arbon changed the title feat: add circle config feat(TA-471): add circle config Feb 22, 2024
Copy link
Contributor

@twba-a twba-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not that i'm expert on this but LGTM.

@darren-arbon darren-arbon merged commit 8cf0dea into main Feb 23, 2024
3 checks passed
@darren-arbon darren-arbon deleted the TA-471-add-circle-config branch February 23, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
90% 90% PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants