Documentation | eng: Update the release procedure (!62)

Wed Oct 23 17:48:21 UTC 2024

Merge request https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62 was reviewed by Joel Sherrill

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113495

 > +  :file:`index.txt`:
 > +      A set of brief release links and instructions as an HTML web
 > +      poage.

Spelling.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113496

 > +      formats. The directory contains compressed files for each
 > +      document and a single archive of all the documentation. An
 > +      SHA512 check sum file is also provided to allow verification of

Checksum -- one word

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113497

 > +      the files. The HTML documentation is available in the
 > +      :file:`docs/html` directory the :file:`docs` directory contains
 > +      the PDF documentation. Links are provided in release coverpage.

coverpage should be two words.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113498

 > +The release numbering scheme changed with RTEMS 5. The project moved
 > +to two release numbers from the traditional three numbers. The major
 > +number was not being used and there was no clear means to determine

means to rationale?

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113499

 > +^^^^^^^^^^^^^
 > +
 > +The release label is a string that cabn be used to provide context

can

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113500

 > +
 > +#. No ``VERSION`` file and the sources resides in a valid version
 > +   controlled repository. The release label shall be a version control

What is a "valid version controlled repository"?

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113501

 > +
 > + - ``6.1.0.acme-corp`` is the vendor release from the fictional Acme
 > +   Corporation based on the RTEMS 6.1.0 release.

This doesn't account for vendor specific versioning past the RTEMS source baseline.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113502

 > +   in the RTEMS Project's Gitlab instance. A read only API key is need
 > +   to create the release notes. The ``README.md`` provides the details
 > +   about the Gitlab key and require configuration file format.

required instead of require?

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113503

 >  
 > -* ``rtems-central.git``
 > +* ``rtems-deplyment.git``

deployment?

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113504

 > -  to be resolved before the first release is made.
 > +#. All issues and merge requests for the release milestone must be
 > +   resolved, closed or moved to a later milestone. Issues can exist

or, ?

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113505

 >  FreeBSD's development. LibBSD also tracks a FreeBSD branch for the
 >  RTEMS release. For example RTEMS 5 tracks FreeBSD 12 as it's release
 >  base. This provides functionaly stability to the RTEMS 5 release by

functionally if spelled wrong but I think it should probably be functional.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113506

 > -    Contributed sources. For example the release scripts used to create the
 > -    release.
 > +  :file:`index.txt`:

Is there a difference between index.txt and README.txt? The descriptions look quite similar.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113507

 > -* Check and make sure the RSB kernel, libbsd and tools reference the
 > -  branch commit.
 > +    * https://gitlab.rtems.org/rtems/pkg/rtems-net-legacy/-/branches

What about net services and lwip? Is this intended to be a complete list?

Update: Probably is a complete list. Just confused by diff. Mark resolved if the list is complete.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113508

 > -   You need to have suitable commit access to the repositories.
 > +#. The release process starts by branching the repositories. The the
 > +   `Branch Procedure`_ details how to branch the main repositories.

The the

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113509

 > -#. Tag the release repositories with the following command:
 > +   ``https://ftp.rtems.org/pub/rtems/releases/<VERSION>/<VERSION>``
 >  

Are there specific permissions and owners on the files and directories that should be checked?

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113510

 > -      git tag 5.1.0
 > -      git push origin 5.1.0
 > +#. Tag the release repositories by creating an in

"an in" is missing a word.

--

Joel Sherrill started a new discussion on eng/release-process.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62#note_113511

 > +===================
 > +
 > +#. The ``VERSION`` is only generated when making releases. It shall not

If you install, is this included? Something similar? Can you tell the version of an installed BSP build?

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/62
You're receiving this email because of your account on gitlab.rtems.org.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20241023/e28d5eed/attachment-0001.htm>