From 37f4da93fe4358f78bb30e8188c14dbbdf2f593a Mon Sep 17 00:00:00 2001 From: Oleg Kulachenko Date: Sat, 14 Oct 2023 00:55:08 +0400 Subject: [PATCH] Fix in README.md Signed-off-by: Oleg Kulachenko Fix README.md Signed-off-by: Oleg Kulachenko --- README.md | 94 ++++--------------------------------------------------- 1 file changed, 6 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index 389ed0f..bba852a 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,8 @@ or [GitHub Actions environment variables](https://docs.github.com/en/actions/lea | Key | Value | Required | Default | |---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------| | `PATH_TO_FILES_DIR` | Path to the directory with the files to be pushed | **Yes** | N/A | -| `NEOFS_ATTRIBUTES` | User attributes in form of Key1=Value1,Key2=Value2. By default, each object contains attributes of relative path to the file and MIME type of the file. | **Yes** | N/A | +| `NEOFS_ATTRIBUTES` | User attributes in form of Key1=Value1,Key2=Value2. By default, each object contains attributes of relative path to the file and MIME type of the file. | **No** | N/A | +| `URL_PREFIX` | Prefix to the url address for each of the files(objects) | **No** | N/A | ### Expiration period environment variables The following variables must be passed as @@ -111,17 +112,6 @@ jobs: push-to-neofs: runs-on: ubuntu-latest steps: - - name: Get the current date - id: date - shell: bash - run: echo "::set-output name=timestamp::$(date +%s)" - - - name: Set RUN_ID - shell: bash - env: - TIMESTAMP: ${{ steps.date.outputs.timestamp }} - run: echo "RUN_ID=${{ github.run_number }}-$TIMESTAMP" >> $GITHUB_ENV - - name: Set up Python uses: actions/setup-python@v4 with: @@ -138,11 +128,12 @@ jobs: STORE_OBJECTS_CID: ${{ vars.STORE_OBJECTS_CID }} EXPIRATION_PERIOD: ${{ vars.EXPIRATION_PERIOD }} PATH_TO_FILES_DIR: ${{ env.PATH_TO_FILES_DIR }} - RUN_ID: ${{ env.RUN_ID }} ``` ## How to store Allure report to NeoFS as static page +See https://github.com/nspcc-dev/gh-push-allure-report-to-neofs for more details. + In the [NeoFS](https://github.com/nspcc-dev/neofs-node) project, we use the following workflow to store the [Allure report](https://github.com/allure-framework/allure2) as a static page in the NeoFS mainnet. This is a good example of practical use of this action. @@ -159,81 +150,8 @@ Of course, you can use any other tool to generate the Allure report and convert can use [allure-commandline](https://github.com/allure-framework/allure-npm) or Allure itself according to [this](https://github.com/allure-framework/allure2/pull/2072) merged pull request. -```yml -name: Run tests and publish Allure test report to NeoFS as static page -on: - push: - branches: [ master ] -jobs: - push-to-neofs: - runs-on: ubuntu-latest - steps: - - name: Get the current date - id: date - shell: bash - run: echo "::set-output name=timestamp::$(date +%s)" - - - name: Set RUN_ID - shell: bash - env: - TIMESTAMP: ${{ steps.date.outputs.timestamp }} - run: echo "RUN_ID=${{ github.run_number }}-$TIMESTAMP" >> $GITHUB_ENV - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.11.6' - - - name: Run tests - timeout-minutes: 480 - if: github.event_name != 'pull_request' - run: | - pytest --alluredir=${GITHUB_WORKSPACE}/allure-results pytest_tests/testsuites - working-directory: testcases - - - name: Generate Allure report - timeout-minutes: 60 - uses: simple-elf/allure-report-action@master - id: allure-report - with: - keep_reports: 100000 - allure_results: allure-results - allure_report: allure-report - allure_history: allure-history - - - name: Сonvert Allure report to static page - id: allure-report-to-static-page - run: | - allure-combine ./allure-report \ - --dest ./comb_report \ - --remove-temp-files \ - --auto-create-folders \ - --ignore-utf8-errors - - - name: Copy attachments from allure-results to comb_report - env: - SOURCE_DIR: ${{ github.workspace }}/allure-results/data/attachments/ - DEST_DIR: ${{ github.workspace }}/comb_report/data/attachments/ - run: | - mkdir -p "$DEST_DIR" - rsync -avm --include='*.zip' -f 'hide,! */' "$SOURCE_DIR" "$DEST_DIR" - echo "PATH_TO_FILES_DIR=${{ github.workspace }}/comb_report" >> $GITHUB_ENV - - - uses: actions/checkout@v4 - - name: Publish to NeoFS - uses: nspcc-dev/gh-push-to-neofs@master - with: - NEOFS_WALLET: ${{ secrets.NEOFS_WALLET }} - NEOFS_WALLET_PASSWORD: ${{ secrets.NEOFS_WALLET_PASSWORD }} - NEOFS_NETWORK_DOMAIN: ${{ vars.NEOFS_NETWORK_DOMAIN }} - NEOFS_HTTP_GATE: ${{ vars.NEOFS_HTTP_GATE }} - STORE_OBJECTS_CID: ${{ vars.STORE_OBJECTS_CID }} - EXPIRATION_PERIOD: ${{ vars.PR_EXPIRATION_PERIOD }} - PATH_TO_FILES_DIR: ${{ env.PATH_TO_FILES_DIR }} - RUN_ID: ${{ env.RUN_ID }} -``` - The Allure report will be available in a web browser at a link like this: -https://http.fs.neo.org/86C4P6uJC7gb5n3KkwEGpXRfdczubXyRNW5N9KeJRW73/53-1696453127/complete.html# +https://http.fs.neo.org/86C4P6uJC7gb5n3KkwEGpXRfdczubXyRNW5N9KeJRW73/53-1696453127/comb_report/complete.html# Attachments will also be available at the link: -https://http.fs.neo.org/86C4P6uJC7gb5n3KkwEGpXRfdczubXyRNW5N9KeJRW73/876-1696502182/data/attachments/ce0fa9e280851f32.zip +https://http.fs.neo.org/86C4P6uJC7gb5n3KkwEGpXRfdczubXyRNW5N9KeJRW73/876-1696502182/comb_report/data/attachments/ce0fa9e280851f32.zip