Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linting #2

Open
2 of 3 tasks
aridyckovsky opened this issue May 5, 2024 · 4 comments
Open
2 of 3 tasks

Add linting #2

aridyckovsky opened this issue May 5, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@aridyckovsky
Copy link
Owner

aridyckovsky commented May 5, 2024

A LaTeX linting implementation for this setup should include:

  • LaTeX Workshop extension options for ChkTeX and LaCheck added to vscode/settings.json
  • GitHub Action workflow for linting before creating a PDF and releasing it
  • A new branch requirement for pushing to main and creating a release
@aridyckovsky aridyckovsky added documentation Improvements or additions to documentation enhancement New feature or request labels May 5, 2024
@aridyckovsky aridyckovsky self-assigned this May 5, 2024
aridyckovsky added a commit that referenced this issue May 5, 2024
…equirement is enforced for releases of CV, per #2. Adds minimal documentation in the README for this.
@aridyckovsky
Copy link
Owner Author

PR #7 handles the new branch requirement for pushing to main and creating a release.

aridyckovsky added a commit that referenced this issue May 5, 2024
… for #2. Update name of create-pdf in favor of build-and-deploy
aridyckovsky added a commit that referenced this issue May 5, 2024
…ME details for handling latexindent and some basic updates to usage. cv.tex formatting updated via linter and indenter for #2
@aridyckovsky
Copy link
Owner Author

The current action used doesn't handle linting correctly -- it appears to find the file and attempt linting, then exits the linting process with a failure.

Run j2kun/chktex-action@v1.0.4
  env:
    GITHUB_TOKEN: ***
/usr/bin/docker run --name b5c4971[2](https://github.com/aridyckovsky/cv/actions/runs/8961356452/job/24608882139#step:4:2)44a99097b4d70acf89c58aa6ffbf2_a0e6f8 --label [4](https://github.com/aridyckovsky/cv/actions/runs/8961356452/job/24608882139#step:4:5)b5c49 --workdir /github/workspace --rm -e "GITHUB_TOKEN" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_ENV
Found local chktexrc
==================================================
Linting /github/workspace/cv/cv.tex
--------------------------------------------------
==================================================

@aridyckovsky
Copy link
Owner Author

Might need to implement a new GitHub Action for linting. Available linting actions are out of date by at least 3 years across the board.

@aridyckovsky
Copy link
Owner Author

Added a workflow for linting but not fully functional yet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant