Skip to content

update #2

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
merged 2,197 commits into from
Aug 23, 2023
Merged

update #2

merged 2,197 commits into from
Aug 23, 2023

Conversation

Gitshaoxiang
Copy link
Owner

No description provided.

htmltiger and others added 30 commits May 27, 2023 01:38
* ButtonClickCheck : add

* ButtonClickCheck : Please add a blank line to the end of the file.

---------

Co-authored-by: Dang-Gun <[email protected]>
* Update repositories.txt

* Update repositories.txt

* Update repositories.txt
Arduino IDE I realized that it's not ready for release due to
compability issues such as using vprintf.
Removing a new library I added earlier today.
Add DHT11 to the library.
* Update repositories.txt

* Update repositories.txt
Add the lib SIOT_Core_Lib
Added Eventfun library
* Update and rename repositories.txt to M304-lib

* Revert inadvertent file rename

---------

Co-authored-by: per1234 <[email protected]>
yfrobot fpm383 library
MatteoPologruto and others added 28 commits August 14, 2023 11:27
Added two new sensor libs for TMP6x and HDC302x temperature sensors. Developed by sndrschnklshk.
* Update repositories.txt

* Update repositories.txt
Added RemoteSerial library v0.0.1
Submit Geekble_note2freq library
Add tedtoal/Button_TT
The goal is to make it possible for any community member to submit libraries to the registry, regardless of their level
of relevant technical expertise. For this reason, the project documentation includes a detailed and comprehensive set of
instructions for submitting a library.

Since the time these instructions were written, a regression was introduced into the GitHub website:

When creating a commit via the GitHub web interface, the dialog allows the user to select which branch the commit should
be made to. Typically this includes two options:

- "Commit directly to the <target branch> branch"
  (where "<target branch>" is the branch the user had selected when they initiated the procedure)
- "Create a new branch for this commit and start a pull request"

If the branch protection rules configured for the target prevent the user from committing to that branch, then the first
of the options is removed (which is the appropriate behavior).

Following GitHub's regression, under the conditions produced by the previous submission procedure, the determination of
whether the first option should be disabled is based on the branch protection configuration of the
arduino/arduino-registry repository, not of the library submitter's fork. This is incorrect because the fork does not
inherit the branch protection settings of the parent, meaning the target branch will never be protected in the fork and
thus that the commit to that branch should be allowed in the dialog.

Because we do have branch protection rules enabled for the `main` branch of the `arduino/library-registry` repo, this
bug causes the default setting in the dialog to be changed from "Commit directly to the main branch" to
"Create a new branch for this commit and start a pull request" when the documented submission procedure is performed.

Strangely, the user flow is significantly different depending on which of these options is selected. The user flow when
"Create a new branch for this commit and start a pull request" is selected forces the user to submit the PR to their own
fork repository instead of to arduino/library-registry. It is essential for the PR to be submitted to
arduino/library-registry so this change in the outcome of the previous documented submission procedure as a side effect
of GitHub's regression is catastrophic.

The submission instructions are hereby updated to once again produce a correct submission. Unfortunately, the procedure
that is now required is more complex and less intuitive than the previous one. In order to mitigate this, I made an
effort to be extra explicit both in describing the actions to be performed, as well as describing the expected result of
each action.

I reported the regression to GitHub. I will change the documentation back to using the more friendly submission
procedure once it is fixed.
Adjust submission procedure documentation to get correct PR base repo
@Gitshaoxiang Gitshaoxiang merged commit 4dcd572 into Gitshaoxiang:main Aug 23, 2023
Gitshaoxiang pushed a commit that referenced this pull request Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment