From 8be828b1f56c1cef7f288669cc3454c19a476981 Mon Sep 17 00:00:00 2001 From: alkoleft Date: Wed, 18 Sep 2024 03:19:39 +0300 Subject: [PATCH] doc --- CODEOWNERS | 3 - README.md | 209 ++++++++++++----------------------------------------- action.yml | 6 +- 3 files changed, 51 insertions(+), 167 deletions(-) delete mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS deleted file mode 100644 index 2e08bd2..0000000 --- a/CODEOWNERS +++ /dev/null @@ -1,3 +0,0 @@ -# Repository CODEOWNERS - -* @actions/actions-oss-maintainers diff --git a/README.md b/README.md index ea06e7b..ba4e20a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Create a GitHub Action Using TypeScript +# Действие GitHub Action для установки `1С:Предприятие` и `1C:EDT` [![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter) ![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg) @@ -6,32 +6,55 @@ [![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml) [![Coverage](./badges/coverage.svg)](./badges/coverage.svg) -Use this template to bootstrap the creation of a TypeScript action. :rocket: - -This template includes compilation support, tests, a validation workflow, -publishing, and versioning guidance. - -If you are new, there's also a simpler introduction in the -[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action). - -## Create Your Own Action - -To create your own action, you can use this repository as a template! Just -follow the below instructions: - -1. Click the **Use this template** button at the top of the repository -1. Select **Create a new repository** -1. Select an owner and name for your new repository -1. Click **Create repository** -1. Clone your new repository +## Использование + +Действие позволяет устанавливать 1С:Предприятие и 1C:EDT для использования в ваших рабочих процессах (workflows). + +Позволяет: + +* Скачивание дистрибутивов с `https://releases.1c.ru`, необходимо указать учетные данные +* Установка в Windows и Linux +* Кеширование скаченных дистрибутивов +* Кеширование инсталляции + +### Установка 1С:Предприятие + +```yml +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Установка 1С:Предприятие + uses: 1CDevFlow/onec-setup-action@main + with: + type: onec # Тип устанавливаемого приложения + onec_version: ${{ inputs.v8_version }} + cache: ${{runner.os == 'Windows'}} + env: + ONEC_USERNAME: ${{ secrets.ONEC_USERNAME }} + ONEC_PASSWORD: ${{ secrets.ONEC_PASSWORD }} +``` -> [!IMPORTANT] -> -> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For -> details on how to use this file, see -> [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). +### Установка 1C:EDT + +```yml +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Установка 1C:EDT + uses: 1CDevFlow/onec-setup-action@main + with: + type: edt # Тип устанавливаемого приложения + edt_version: ${{ inputs.edt_version }} + cache: true + env: + ONEC_USERNAME: ${{ secrets.ONEC_USERNAME }} + ONEC_PASSWORD: ${{ secrets.ONEC_PASSWORD }} + timeout-minutes: 30 +``` -## Initial Setup +## Contributing After you've cloned the repository to your local machine or codespace, you'll need to perform some initial setup steps before you can develop your action. @@ -72,87 +95,6 @@ need to perform some initial setup steps before you can develop your action. ... ``` -## Update the Action Metadata - -The [`action.yml`](action.yml) file defines metadata about your action, such as -input(s) and output(s). For details about this file, see -[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions). - -When you copy this repository, update `action.yml` with the name, description, -inputs, and outputs for your action. - -## Update the Action Code - -The [`src/`](./src/) directory is the heart of your action! This contains the -source code that will be run when your action is invoked. You can replace the -contents of this directory with your own code. - -There are a few things to keep in mind when writing your action code: - -- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously. - In `main.ts`, you will see that the action is run in an `async` function. - - ```javascript - import * as core from '@actions/core' - //... - - async function run() { - try { - //... - } catch (error) { - core.setFailed(error.message) - } - } - ``` - - For more information about the GitHub Actions toolkit, see the - [documentation](https://github.com/actions/toolkit/blob/master/README.md). - -So, what are you waiting for? Go ahead and start customizing your action! - -1. Create a new branch - - ```bash - git checkout -b releases/v1 - ``` - -1. Replace the contents of `src/` with your action code -1. Add tests to `__tests__/` for your source code -1. Format, test, and build the action - - ```bash - npm run all - ``` - - > This step is important! It will run [`ncc`](https://github.com/vercel/ncc) - > to build the final JavaScript action code with all dependencies included. - > If you do not run this step, your action will not work correctly when it is - > used in a workflow. This step also includes the `--license` option for - > `ncc`, which will create a license file for all of the production node - > modules used in your project. - -1. Commit your changes - - ```bash - git add . - git commit -m "My first action is ready!" - ``` - -1. Push them to your repository - - ```bash - git push -u origin releases/v1 - ``` - -1. Create a pull request and get feedback on your action -1. Merge the pull request into the `main` branch - -Your action is now published! :rocket: - -For information about versioning your action, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) -in the GitHub Actions toolkit. - ## Validate the Action You can now validate the action by referencing it in a workflow file. For @@ -178,58 +120,3 @@ steps: For example workflow runs, check out the [Actions tab](https://github.com/actions/typescript-action/actions)! :rocket: - -## Usage - -After testing, you can create version tag(s) that developers can use to -reference different stable versions of your action. For more information, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) -in the GitHub Actions toolkit. - -To include the action in a workflow in another repository, you can use the -`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit -hash. - -```yaml -steps: - - name: Checkout - id: checkout - uses: actions/checkout@v4 - - - name: Test Local Action - id: test-action - uses: actions/typescript-action@v1 # Commit with the `v1` tag - with: - milliseconds: 1000 - - - name: Print Output - id: output - run: echo "${{ steps.test-action.outputs.time }}" -``` - -## Publishing a New Release - -This project includes a helper script, [`script/release`](./script/release) -designed to streamline the process of tagging and pushing new releases for -GitHub Actions. - -GitHub Actions allows users to select a specific version of the action to use, -based on release tags. This script simplifies this process by performing the -following steps: - -1. **Retrieving the latest release tag:** The script starts by fetching the most - recent SemVer release tag of the current branch, by looking at the local data - available in your repository. -1. **Prompting for a new release tag:** The user is then prompted to enter a new - release tag. To assist with this, the script displays the tag retrieved in - the previous step, and validates the format of the inputted tag (vX.X.X). The - user is also reminded to update the version field in package.json. -1. **Tagging the new release:** The script then tags a new release and syncs the - separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0, - v2.1.2). When the user is creating a new major release, the script - auto-detects this and creates a `releases/v#` branch for the previous major - version. -1. **Pushing changes to remote:** Finally, the script pushes the necessary - commits, tags and branches to the remote repository. From here, you will need - to create a new release in GitHub so users can easily reference the new tags - in their workflows. diff --git a/action.yml b/action.yml index aabcd57..ae843be 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,6 @@ -name: 'The name of your action here' -description: 'Provide a description here' -author: 'Your name or organization here' +name: 'Installer 1C:Enterprise 8 and 1C:EDT' +description: 'Allows you to install 1C:Enterprise 8 or 1C:EDT of the required version' +author: '1CDevFlow' # Add your action's branding here. This will appear on the GitHub Marketplace. branding: