Skip to content

Commit

Permalink
chore: prepare public release
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgecasar committed Jan 11, 2024
1 parent 624e540 commit b99ac5c
Show file tree
Hide file tree
Showing 32 changed files with 628 additions and 2,366 deletions.
10 changes: 10 additions & 0 deletions .changeset/lucky-flowers-repair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"@sngular/semantic-release-config": major
"@sngular/lint-staged-config": major
"@sngular/commitlint-config": major
"@sngular/prettier-config": major
"@sngular/tsconfig": major
"@sngular/eslint-config": major
---

Public release
2 changes: 1 addition & 1 deletion .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
module.exports = { extends: '@os3' };
module.exports = { extends: '@sngular' };
14 changes: 14 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Greetings

on: [pull_request, issues]

jobs:
greeting:
runs-on: ubuntu-latest
steps:
- uses: actions/first-interaction@v1
continue-on-error: true
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: 'Thank you for collaborating with the project by giving us feedback!'
pr-message: 'Thank you for collaborating with the project to help us improve! We hope this CLI is useful to you. Cheers!'
42 changes: 42 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Release

on:
push:
branches:
- main

concurrency: ${{ github.workflow }}-${{ github.ref }}

jobs:
release:
# Prevents changesets action from creating a PR on forks
if: github.repository == 'sngular/javascript'
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
persist-credentials: false

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 'lts/*'

- name: Install dependencies
run: npm clean-install

- name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
run: npm audit signatures

- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
with:
publish: npm run release
commit: "chore: version packages"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
32 changes: 32 additions & 0 deletions .github/workflows/verify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Verify changes

on: pull_request

jobs:
verify:
name: Verify changes
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
persist-credentials: false

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 'lts/*'
registry-url: 'https://registry.npmjs.org'

- name: Install Dependencies
run: npm install --ci

- name: Lint
run: npm run lint:check

- name: Format
run: npm run format:check

- name: Types
run: npm run types:check
101 changes: 0 additions & 101 deletions .gitlab-ci.yml

This file was deleted.

1 change: 0 additions & 1 deletion .npmrc

This file was deleted.

16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Javascript quality guidelines

In order to enforcing OS3 style guidelines. We created the following packages to help projects implement linters easily.
In order to enforcing SNGULAR style guidelines. We created the following packages to help projects implement linters easily.

- [@os3/commitlint-config](./packages/commitlint/README.md)
- [@os3/eslint-config](./packages/eslint/README.md)
- [@os3/lint-staged-config](./packages/lint-staged/README.md)
- [@os3/prettier-config](./packages/prettier/README.md)
- [@os3/semantic-release-config](./packages/semantic-release/README.md)
- [@os3/tsconfig](./packages/tsconfig/README.md)
- [@sngular/commitlint-config](./packages/commitlint/README.md)
- [@sngular/eslint-config](./packages/eslint/README.md)
- [@sngular/lint-staged-config](./packages/lint-staged/README.md)
- [@sngular/prettier-config](./packages/prettier/README.md)
- [@sngular/semantic-release-config](./packages/semantic-release/README.md)
- [@sngular/tsconfig](./packages/tsconfig/README.md)

You can also configure [`.editorconfig`](./.editorconfig) file to ensure your code editor follow the style guide.

Some of the packages (commitlint & lint-staged) are created to work with [husky](https://typicode.github.io/husky/) to make git hook easy. We recomend to follow the [manual installation](https://typicode.github.io/husky/#/?id=manual) and then add the following hooks to your project:
Some of the packages (commitlint & lint-staged) are created to work with [husky](https://typicode.github.io/husky/) to make git hook easy. We recommend to follow the [manual installation](https://typicode.github.io/husky/#/?id=manual) and then add the following hooks to your project:

- Hook for lint commit messages:

Expand Down
2 changes: 1 addition & 1 deletion commitlint.config.cjs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
module.exports = { extends: ['@os3'] };
module.exports = { extends: ['@sngular'] };
2 changes: 1 addition & 1 deletion lint-staged.config.cjs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
module.exports = require('@os3/lint-staged-config');
module.exports = require('@sngular/lint-staged-config');
Loading

0 comments on commit b99ac5c

Please sign in to comment.