Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Clean up taskfile #243

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

Merged
per1234 merged 3 commits into arduino:main from per1234:clean-taskfile
Aug 6, 2021
Merged

Clean up taskfile #243

per1234 merged 3 commits into arduino:main from per1234:clean-taskfile
Aug 6, 2021

Conversation

Copy link
Contributor

@per1234 per1234 commented Aug 6, 2021

Some housekeeping and streamlining of the Task configuration file that provides common development operations for this project.

@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 6, 2021
Copy link

codecov-commenter commented Aug 6, 2021
edited
Loading

Codecov Report

Merging #243 (f776e59) into main (f5072eb) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@ Coverage Diff @@
## main #243 +/- ##
=======================================
 Coverage 89.85% 89.85% 
=======================================
 Files 43 43 
 Lines 6320 6320 
=======================================
 Hits 5679 5679 
 Misses 530 530 
 Partials 111 111 
Flag Coverage Δ
unit 89.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f5072eb...f776e59. Read the comment docs.

per1234 added 3 commits August 6, 2021 02:50
The uses of these was eliminated in the updates to the formatting and documentation infrastructure, but I forgot to
remove them from the taskfile at that time.
There is an established practice of providing the developer with convenience tasks which collect all the domain-specific
tasks of a given class. This has a couple of benefits:
- Provides an alternative to manually running multiple tasks
- Provides a standardized interface to the project, independent from its unique underlying details
However, I have come to the conclusion that these benefits lessen as the number of such convenience tasks increases. At
the same time, the maintenance burden increases. In the end, I think there are only three distinct classes of tasks that
can be consolidated in this manner:
- "build" (build the application)
- "check" (check for problems with the project)
- "fix" (automatically fix problems with the project)
I originally set out to establish some logical order to the tasks, based partly on the Arduino CLI taskfile, as that
project was used as a model, then on some indecipherable criteria of my own devizing in cases where the model did not
provide guidance. In the end, it resulted in a jumble.
Alphabetical order is completely objective and it results in a fairly logical order in the end due to the the use of
prefixes on the task names according to their domain. The exception is that the convenience "umbrella" tasks have been
left at the top (in their own alphabetical order) so that they will have the maximum visibility as the most useful tasks.
Even that is not completely inconsistent, since these don't have a namespace prefix, and so might be imagined to have a
null global namespace prefix that would be sorted first.
@per1234 per1234 merged commit 2ef9fcb into arduino:main Aug 6, 2021
@per1234 per1234 deleted the clean-taskfile branch August 6, 2021 10:13
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@umbynos umbynos Awaiting requested review from umbynos

@rsora rsora Awaiting requested review from rsora

1 more reviewer

@silvanocerza silvanocerza silvanocerza approved these changes

Reviewers whose approvals may not affect merge requirements
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /