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

Cleanup working with tags tutorial #558

Merged
merged 1 commit into from
Jul 11, 2023

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Jul 6, 2023

Tutorial edited for simplification and style guide. Additional changes were needed to reflect the introduction of fast first Target in v91. As this change means there are no longer devel and master branches, much of this tutorial needed to be modified. Information was added pointing to the reference manual page on having the CI follow branches. This is a stop-gap measure until an additional tutorial is added which will focus on adding an additional branch. At that point, this tutorial will be revised again.

QA steps: ran linter, checked output in browser.

This commit addresses FFTK-2517
This commit applies to FFTK-2510
This commit applies to FFTK-2430
This commit applies to FFTK-988

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Oy.

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

See commit message...this tutorial is going to be a bit awkward until we add an additional one, I tried to make it work out as best as possible for the time being, but suggestions are very welcome.

@kprosise kprosise requested review from doanac, vanmaegima and a team July 6, 2023 17:15
@doanac
Copy link
Member

doanac commented Jul 6, 2023

Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

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

LGTM

and generate a new **Target** tagged with ``devel``. As a result, devices following
``devel`` will update to the latest **Target**.
Whenever you change the ``devel`` branch, FoundriesFactory® CI will build and generate a new Target tagged with ``devel``.
As a result, devices following ``devel`` will update to the latest Target.
Copy link
Member

Choose a reason for hiding this comment

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

I may have missed it, but since the repository won't have a devel branch, should we just have this whole thing set to for the main branch instead?

Also - for wording, I think "change the devel branch" is confusing - For a minute I thought we were saying something different. Maybe "When you push changes to the branch..."

Copy link
Member

Choose a reason for hiding this comment

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

i see below you talk about setting up a devel branch now. I guess the bigger question is: "Do we want to force devel upon people to get started?". I thought the answer was "no" and we just want to get people up to speed making changes directly on main.

If we want them on devel - i can change the factory setup to include rules for a devel branch. Maybe we need @mike-scott to weigh in here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mike-scott @rsalveti @doanac Do we have a decision on this for v91? To clarify/restate:

  • This will be proceeded by a new tutorial on creating a new branch, but that won't be ready for this release
  • In the meantime, there is a bit of a disclaimer on this tutorial that it will require creating a devel branch first, I can expand on that a bit
  • We can pull this tutorial for now and reintroduce it once the branching tutorial is ready, or we can keep it as it is in this commit.

Copy link
Member

Choose a reason for hiding this comment

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

i think it makes sense. this whole article is about working with tags.

@doanac
Copy link
Member

doanac commented Jul 7, 2023

@doanac
Copy link
Member

doanac commented Jul 7, 2023

@doanac
Copy link
Member

doanac commented Jul 11, 2023

Tutorial edited for simplification and style guide.
Additional changes were needed to reflect the introduction of fast first
Target in v91. As this change means there are no longer devel and master
branches, much of this tutorial needed to be modified. Information was
added pointing to the reference manual page on having the CI follow
branches. This is a stop-gap measure until an additional tutorial is
added which will focus on adding an additional branch. At that point,
this tutorial will be revised again.

QA steps: ran linter, checked output in browser.

This commit addresses FFTK-2517
This commit applies to FFTK-2510
This commit applies to FFTK-2430
This commit applies to FFTK-988

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@doanac
Copy link
Member

doanac commented Jul 11, 2023

@kprosise kprosise merged commit 807c621 into foundriesio:main Jul 11, 2023
1 check passed
@kprosise kprosise deleted the cleanup-tag-tutorial branch July 11, 2023 15:15
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.

3 participants