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

chore: Reorganize and expand Justfile commands #127

Merged
merged 1 commit into from
Oct 5, 2024

Conversation

JackPlowman
Copy link
Owner

@JackPlowman JackPlowman commented Oct 5, 2024

Pull Request

Description

This update significantly enhances the Justfile by reorganizing and expanding the available commands. Key changes include:

  • Added new commands for installing dependencies, running the analyser, and executing unit tests
  • Introduced a command to validate the schema of generated statistics files
  • Reorganized commands into logical sections: Common Commands, Cleaning Commands, Docker Commands, Ruff (Python Linting and Formatting), Other Python Tools, Prettier, and Justfile
  • Added detailed comments for each command to improve clarity and usability
  • Expanded Docker-related commands for building images and running the analyser in a container
  • Enhanced Ruff commands for linting and formatting Python code
  • Added commands for Prettier to check and format files
  • Included commands for formatting and checking the Justfile itself

These changes improve the overall structure and functionality of the Justfile, making it easier for developers to manage and maintain the project.

fixes #128

@JackPlowman JackPlowman changed the title Document Just Commands chore: Reorganize and expand Justfile commands Oct 5, 2024
@github-actions github-actions bot added the just Pull requests that update Just code label Oct 5, 2024
Copy link
Owner Author

JackPlowman commented Oct 5, 2024

@JackPlowman JackPlowman marked this pull request as ready for review October 5, 2024 19:16
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from 5f42d74 to b14a7f7 Compare October 5, 2024 19:17
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from dd1e169 to 67ce56e Compare October 5, 2024 19:17
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from b14a7f7 to e7d9044 Compare October 5, 2024 19:18
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from 67ce56e to 9072e78 Compare October 5, 2024 19:18
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from e7d9044 to bd3b30f Compare October 5, 2024 19:19
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from 9072e78 to 2b941e5 Compare October 5, 2024 19:19
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from bd3b30f to ce9b922 Compare October 5, 2024 19:21
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch 2 times, most recently from fe1f2d6 to dcfa08e Compare October 5, 2024 19:23
@github-actions github-actions bot added python Pull requests that update Python code analyser Pull requests that update analyser code labels Oct 5, 2024
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from ce9b922 to b8eb695 Compare October 5, 2024 19:23
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from dcfa08e to 04ecba2 Compare October 5, 2024 19:24
@github-actions github-actions bot removed python Pull requests that update Python code analyser Pull requests that update analyser code labels Oct 5, 2024
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from b8eb695 to 09daeeb Compare October 5, 2024 19:27
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from 04ecba2 to de49d0b Compare October 5, 2024 19:27
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from 09daeeb to 2cd9a2d Compare October 5, 2024 19:31
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from de49d0b to be77cc8 Compare October 5, 2024 19:31
@JackPlowman JackPlowman force-pushed the 10-05-add_python_script_to_check_environment_variables branch from 2cd9a2d to 3cff009 Compare October 5, 2024 19:32
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from be77cc8 to 8d4d4e0 Compare October 5, 2024 19:32
@JackPlowman JackPlowman changed the base branch from 10-05-add_python_script_to_check_environment_variables to graphite-base/127 October 5, 2024 19:35
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from 8d4d4e0 to c5c3707 Compare October 5, 2024 19:35
@JackPlowman JackPlowman changed the base branch from graphite-base/127 to main October 5, 2024 19:36
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from c5c3707 to 6c84340 Compare October 5, 2024 19:36
@JackPlowman JackPlowman force-pushed the 10-05-document_just_commands branch from 6c84340 to 449793a Compare October 5, 2024 19:38
Copy link

sonarcloud bot commented Oct 5, 2024

@JackPlowman JackPlowman merged commit ad0aa60 into main Oct 5, 2024
28 checks passed
Copy link
Owner Author

Merge activity

@JackPlowman JackPlowman deleted the 10-05-document_just_commands branch October 5, 2024 19:41
JackPlowman added a commit that referenced this pull request Oct 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.1.0](v1.0.1...v1.1.0)
(2024-10-06)


### 🚀 Features

* Build and Push GitHub Package
([#131](#131))
([dbbc4df](dbbc4df)),
closes
[#132](#132)


### 🧰 Maintenance

* Add .dockerignore file
([#108](#108))
([4f96c7d](4f96c7d)),
closes
[#114](#114)
* Add environment variable check script
([#126](#126))
([2596b6f](2596b6f)),
closes
[#125](#125)
* Create reusable setup-dependencies action
([#123](#123))
([3ff9743](3ff9743)),
closes
[#124](#124)
* Group GitHub Actions dependencies in Dependabot config
([#112](#112))
([2cd5914](2cd5914)),
closes
[#117](#117)
* Refactor statistics file handling and improve logging
([#121](#121))
([c4a3d9e](c4a3d9e)),
closes
[#122](#122)
* Reorganize and expand Justfile commands
([#127](#127))
([ad0aa60](ad0aa60)),
closes
[#128](#128)
* Standardise environment variable names
([#129](#129))
([203c593](203c593)),
closes
[#130](#130)
* Update GitHub Actions dependencies
([#113](#113))
([7a51401](7a51401)),
closes
[#118](#118)
* Update workflows and remove action preview
([#109](#109))
([db4bf42](db4bf42)),
closes
[#115](#115)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
just Pull requests that update Just code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document and organise Just commands
1 participant