맞춤법 검사(GitHub) 작업의 릴리스 0.24.0 - 선택적 아티팩트를 도입하는 기능 릴리스

Spellcheck GitHub Action - 0.24.0 의 새로운 기능 릴리스를 발표하게 되어 기쁩니다.

기능 릴리스에서는 작업의 핵심 구성 요소인 작업 실행pyspelling의 모든 출력으로 아티팩트를 생성하는 기능을 소개합니다.

이 아이디어는 버전0.18.0에 기여한 Riccardo Porreca(@riccardoporreca)가 제안했습니다.

저는 GitHub 작업 아티팩트 작업 경험이 전혀 없는 상태에서 아이디어를 조사하기 시작했습니다. 나는 그것이 작동하도록 했지만 그것이 작동하는지 확인하기 위해 초기 변경 사항을 푸시해야 했습니다. 즉, 마스터 분기가 불안정해졌습니다(문서에서 명시한 것). 그러나 아티팩트를 지정하고 생성할 수 있었기 때문에 완전히 성공하지 못했습니다. 하지만 Docker 이미지에서 추출할 수 없습니다. Docker를 로컬에서 사용할 때 아티팩트를 검색할 수 있지만 이것은 GitHub 작업이므로 조금 더 필요했습니다.

나는 상태로 Riccardo에게 연락했고 운 좋게도 그는 주제에 대해 잘 알고 있으며 우리는 솔루션을 조정할 수 있습니다.

또한 Riccardo는 개선을 위한 몇 가지 지침을 제게 제공했고 저는 이를 구현하기 시작했고 진행하면서 모든 것을 깨뜨렸습니다. 나는 계속해서 코드를 테스트하고 개선하여 작동하도록 했습니다. Riccardo가 내가 저지른 모든 오류를 지적했다는 것을 알게 된 것뿐입니다. 글쎄, 우리는 결국 같은 지점에 도달했지만 구역화하는 대신 내 알림에 주의를 기울였더라면 언젠가는 절약할 수 있었을 것입니다("Drone Zone "에게 감사드립니다).

초기 아이디어, 리뷰, 의견 및 제안에 대해 Riccardo에게 감사드립니다.

아티팩트에 대한 아이디어는 Riccardo가 무엇을 하고 싶은지 잘 모르지만 출력을 검색하고 선호하는 툴체인을 사용하여 철자 오류를 수정하기 위해 처리할 수 있는 사용 사례를 볼 수 있습니다.

아티팩트는 물론 GitHub UI를 통해 다운로드할 수 있습니다. 그러나 API를 통해 액세스할 수도 있습니다.

다음 예는 GitHub CLI client ( documentation )을 사용하지만 curl 또는 이와 유사한 것을 사용할 수 있습니다. 자세한 내용은 참조 문서를 참조하십시오.

먼저 아티팩트를 원한다고 구성합니다.

name: Spellcheck Action
on: push

jobs:
  build:
    name: Spellcheck
    runs-on: ubuntu-latest
    steps:
    # The checkout step
    - uses: actions/checkout@master
    - uses: rojopolis/[email protected]
      name: Spellcheck
      with:
        source_files: README.md CHANGELOG.md notes/Notes.md
        task_name: Markdown
        output_file: spellcheck-output.txt

새로운 흥미로운 매개변수는 output_file입니다. 이는 인에이블러 역할을 하며 아티팩트의 이름을 지정할 수도 있습니다.

output_file: spellcheck-output.txt

둘째, 테스트를 실행합니다.

gh workflow run "Spellcheck Action"

주의! 맞춤법 검사 작업의 이름은 다를 수 있습니다.

그런 다음 유물이 있는지 묻습니다.

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /repos/rojopolis/spellcheck-github-actions/actions/artifacts

JSON 응답에서 원하는 아티팩트의 ID를 추출합니다.

그런 다음 아티팩트를 다운로드합니다.

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /repos/rojopolis/spellcheck-github-actions/actions/artifacts/243391075,/zip > artifact.zip

아티팩트의 압축을 풉니다.

unzip artifact.zip

아티팩트를 검사합니다(구성에 지정된 대로 spellcheck-output.txt).

cat spellcheck-output.txt
Spelling check passed :)

철자 오류가 여러 개 있거나 사용자 정의 사전에 대한 후보가 있는 경우 결과는 당연히 더 흥미로워집니다. 많은 출력을 원하거나 임시로 비우려면 언어를 전환하십시오.wordlist.txt.

아티팩트는 3개월 동안 사용할 수 있으며 API(및 내가 믿는 UI)를 통해 나열, 보기 및 삭제할 수 있습니다.

이 새로운 기능에 대한 피드백과 질문은 여기와 the Discussions section in the GitHub repository에서 환영합니다.

변경 로그

0.24.0, 2022-05-17, 기능 릴리스, 업데이트 필요 없음

@riccardoporreca 생성 문제#68에서 출력 아티팩트 생성 기능을 요청했습니다.

릴리스 0.24.0에서는 이제 사용할 수 있습니다.

작업 구성에는 새 선택적 매개 변수인 output_file 매개 변수가 지정되어 있어야 합니다.

  name: Spellcheck Action

  on:
    workflow_dispatch:
    push:

  jobs:
    build:
      name: Spellcheck
      runs-on: ubuntu-latest
      steps:

      - uses: actions/checkout@v3

      - uses: rojopolis/[email protected]
        name: Spellcheck (no output file)
        with:
          source_files: README.md CHANGELOG.md

      - uses: rojopolis/[email protected]
        name: Spellcheck (with output file)
        with:
          source_files: README.md CHANGELOG.md
          task_name: Markdown
          output_file: spellcheck-output.txt

      - uses: actions/upload-artifact@v3
        name: Archive spellcheck output output
        with:
          name: Spellcheck artifact
          path: spellcheck-output.txt

이것은 upload-artifact@v3 작업의 사용을 소개합니다.

생성된 아티팩트는 GitHub UI/API를 통해 다운로드할 수 있습니다. 자세한 내용과 포인터는 설명서를 참조하십시오.

그의 제안과 PR에 대한 추가 검토 및 의견에 대해 @riccardoporreca에게 감사드립니다.

릴리스는 365일 동안 사용할 수 있으며 새sunset policy