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

fix: Remove build:id in generic examples #596

Merged
merged 2 commits into from
Jul 21, 2022

Conversation

laurentsimon
Copy link
Collaborator

No description provided.

@laurentsimon laurentsimon requested review from loosebazooka and removed request for ianlewis, asraa and joshuagl July 20, 2022 16:14
@laurentsimon laurentsimon enabled auto-merge (squash) July 20, 2022 16:14
internal/builders/generic/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@olivekl olivekl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case I'd label them, yes, because it's otherwise hard to parse visually. BUT: I'd suggest taking the steps out of the comments entirely and having them in regular text, followed by the code example for that step. That way it's very clear (visually) to the user what the steps are when glancing over the docs, and they're only copying code comments into their system that are descriptive info reminding them of what the code does.

@laurentsimon
Copy link
Collaborator Author

laurentsimon commented Jul 21, 2022

In this case I'd label them, yes, because it's otherwise hard to parse visually. BUT: I'd suggest taking the steps out of the comments entirely and having them in regular text, followed by the code example for that step. That way it's very clear (visually) to the user what the steps are when glancing over the docs, and they're only copying code comments into their system that are descriptive info reminding them of what the code does.

So you mean something like the following, instead of inlining the comments in the code:

  • Step 1: add bla to your code
uses: builder@v1.2
  • Step 2: add bla 2 to your code
jobs:
  id: bla

@olivekl
Copy link
Contributor

olivekl commented Jul 21, 2022

So you mean something like the following, instead of inlining the comments in the code:

  • Step 1: add bla to your code
uses: builder@v1.2

Exactly.

@laurentsimon
Copy link
Collaborator Author

So you mean something like the following, instead of inlining the comments in the code:

  • Step 1: add bla to your code
uses: builder@v1.2

Exactly.

I've made the changes. Thank you both for the feedback.

@laurentsimon laurentsimon merged commit e3a5704 into slsa-framework:main Jul 21, 2022
@ianlewis
Copy link
Member

Thanks @olivekl !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants