Skip to content

Commit

Permalink
docs: Add instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
BondarenkoAlex committed Mar 11, 2024
1 parent 25df345 commit a37f4b4
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## Как пользоваться.

### Подготовка

1. Склонировать реп `git clone [email protected]:BondarenkoAlex/semantic-release-github-actions-simple-example.git`

1. Установить все зависимости `npm ci`

1. Добавить для `github` - [Personal access token (classic)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)

Разрешения должны быть как написано [тут](https://github.com/semantic-release/github?tab=readme-ov-file#github-authentication)

1. Добавить для `npm` - [Access token (classic)](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens)

Разрешение должно быть `Publish`

### Для публикации из локальной машины

Запустить команду

`GH_TOKEN=<github_token> NPM_TOKEN=<npm_token> npx semantic-release --no-ci`

где `<github_token>` и `<npm_token>` строки, которые были сгенерированы в предыдущих пунктах соответственно

### Для публикации с помощью `github action (workflows)`

1. Надо дать разрешения `Workflow permissions`.

Для этого: `Your repo``Settings` tab → `Actions` tab → `General` subtab → `Workflow permissions``Read and write permissions` check

Почитать можно [Modifying the permissions for the GITHUB_TOKEN](https://docs.github.com/ru/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)

1. Добавить `Secrets and variables`

Перейти `Your repo``Settings` tab → `Secrets and variables``Actions``Repository secrets``New repository secret`

Добавить два ключа:

- Name: `GH_TOKEN`; Secret: `<строка, которая была сгенерирована в предыдущих пунктах>`

- Name: `NPM_TOKEN`; Secret: `<строка, которая была сгенерирована в предыдущих пунктах>`

1. Все. Делаем коммит (по [конвенции коммитов](https://www.conventionalcommits.org/ru/v1.0.0/)) и отправляем в репозиторий



0 comments on commit a37f4b4

Please sign in to comment.