Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Commit

Permalink
added new changes for contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
mascardoso committed May 27, 2022
1 parent 7047af6 commit bd1a90d
Show file tree
Hide file tree
Showing 8 changed files with 214 additions and 2,614 deletions.
30 changes: 15 additions & 15 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# name: "Lint PR"
# on:
# pull_request_target:
# types:
# - opened
# - edited
# - synchronize
# jobs:
# main:
# name: Validate PR title
# runs-on: ubuntu-latest
# steps:
# - uses: amannn/action-semantic-pull-request@v4
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
name: "Lint PR"
on:
pull_request_target:
types:
- opened
- edited
- synchronize
jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
37 changes: 19 additions & 18 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ on:
release:
types: [created]
jobs:
# build-publish:
# runs-on: ubuntu-latest
# steps:
# - name: Checkout
# uses: actions/checkout@v2
# - name: Setup Node
# uses: actions/setup-node@v2
# with:
# node-version: '17.x'
# registry-url: 'https://registry.npmjs.org'
# - name: Install dependencies and test 🔧
# run: npm install && npm run test
# - name: Publish package on NPM 📦
# run: npm publish --access=public
# env:
# NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
build-publish:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '17.x'
registry-url: 'https://registry.npmjs.org'
- name: Install dependencies and test 🔧
run: npm install && npm run test
- name: Publish package on NPM 📦
run: npm publish --access=public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
generate-changelog:
runs-on: ubuntu-latest
steps:
Expand All @@ -28,7 +28,8 @@ jobs:
- uses: BobAnkh/auto-generate-changelog@master
with:
REPO_NAME: ''
PULL_REQUEST: ''
ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}
PATH: 'CHANGELOG.md'
COMMIT_MESSAGE: 'docs(CHANGELOG): updated release notes'
TYPE: 'feat:Features,fix:Patches,docs:Documentation,refactor:Refactor,test:Tests,chore:Others'
COMMIT_MESSAGE: 'docs(CHANGELOG): update release notes'
TYPE: 'feat:Features,fix:Bug Fixes,docs:Documentation,refactor:Refactor,test:Tests,perf:Performance Improvements,build:Builds,ci:CI,chore:Others,revert:Reverts'
4 changes: 0 additions & 4 deletions .husky/commit-msg

This file was deleted.

43 changes: 0 additions & 43 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,7 @@
# CHANGELOG

## [v1.1.0](https://github.com/lokalise/eslint-plugin/releases/tag/v1.1.0) - 2022-05-24 11:52:12

## What's Changed
* docs: add contribution release notes by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/8
* feat: added conventional commits to PR Titles by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/9
* docs: added release process in contributing.md by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/10
* feat: added automated changelogs by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/11
* fix: fixing automated changelog by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/12


**Full Changelog**: https://github.com/lokalise/eslint-plugin/compare/v1.0.0...v1.1.0

### Features

- general:
- added automated changelogs (#11) ([14de364](https://github.com/lokalise/eslint-plugin/commit/14de364745be23b9595b26b68ef710023acb8ea4)) ([#11](https://github.com/lokalise/eslint-plugin/pull/11))
- added conventional commits to PR Titles (#9) ([bbbc9a1](https://github.com/lokalise/eslint-plugin/commit/bbbc9a14d9e5ffba8bdd2a3cffb4ba40dbd03887)) ([#9](https://github.com/lokalise/eslint-plugin/pull/9))

### Patches

- general:
- removed pr linting ([ce73416](https://github.com/lokalise/eslint-plugin/commit/ce73416cfbc0dba1f20d9bfc137939ec78b017d8))
- fixing automated changelog (#12) ([3e8b97f](https://github.com/lokalise/eslint-plugin/commit/3e8b97fbe915513f15306ff1b0006341e2b9b9be)) ([#12](https://github.com/lokalise/eslint-plugin/pull/12))

### Documentation

- general:
- added release process in contributing.md (#10) ([0f6e51f](https://github.com/lokalise/eslint-plugin/commit/0f6e51f83b49f007669e9b5039b1c613ffc899a4)) ([#10](https://github.com/lokalise/eslint-plugin/pull/10))
- add contribution release notes (#8) ([7d6b5ac](https://github.com/lokalise/eslint-plugin/commit/7d6b5ac008fca35cd388cb3e6bca20ecc2ff95ce)) ([#8](https://github.com/lokalise/eslint-plugin/pull/8))

## [v1.0.0](https://github.com/lokalise/eslint-plugin/releases/tag/v1.0.0) - 2022-05-23 19:33:26

## What's Changed
* BB-61 added eslint plugin by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/1
* feat(linting): added support for conventional commits and husky by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/2
* fix(linting): fixed contributing hyperlink for conventional commits by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/3
* feat: added release-it to eslint-plugin #4 by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/5
* fix: removed release-it by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/6
* fix: added public npm option by @mascardoso in https://github.com/lokalise/eslint-plugin/pull/7

## New Contributors
* @mascardoso made their first contribution in https://github.com/lokalise/eslint-plugin/pull/1

**Full Changelog**: https://github.com/lokalise/eslint-plugin/commits/v1.0.0

### Features

- general:
Expand Down
21 changes: 8 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,14 @@ We'd also love PRs. If you're thinking of a large PR, we advise opening up an is
- Add necessary tests
- Add docs for the specific rules
- Bump the package using [SEMVER](https://semver.org/) approach.
- Commit ([conventional commits guidelines](https://platform.uno/docs/articles/uno-development/git-conventional-commits.html)) and push
- Commit and push your changes
1. Squash and merge the pull request in `main`.
- The title of the PR needs to follow ([conventional commits guidelines](https://platform.uno/docs/articles/uno-development/git-conventional-commits.html)) as it will be used for changelog purposes.
- If it is a breaking change include `!` next to the type of your commit as in `fix!: removed prop x`
1. Release.
- Draft a new release
- Add a new tag based on your previous bump `vx.x.x`
- Add `chore: release vx.x.x` to the title of the release.
- Auto generate the release notes.
- Draft a [new release](https://github.com/lokalise/eslint-plugin/releases/new)
- Add a new tag based on [current main branch](https://github.com/lokalise/eslint-plugin/blob/main/package.json#L3) package version `vx.x.x`
- Add in description breaking changes related info if necessary
- Publish Release
- Confirm the new package was uploaded successfully in [npm](https://www.npmjs.com/package/@lokalise/eslint-plugin)
1. Done 🚀

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
1 change: 0 additions & 1 deletion commitlint.config.js

This file was deleted.

Loading

0 comments on commit bd1a90d

Please sign in to comment.