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.

Sign up for GitHub

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

Jump to bottom

examples: restructure examples folder #21135

Merged
merged 1 commit into from
Feb 13, 2025
Merged

examples: restructure examples folder #21135

merged 1 commit into from
Feb 13, 2025
+1,043 −143

Conversation

AnnsAnns
Copy link
Contributor

@AnnsAnns AnnsAnns commented Jan 14, 2025 •
edited
Loading

Contribution description

After #20957 we added a proper structure to the examples folder. This wasn't yet reflected in the actual folder structure within the examples folder. After positive feedback in the Matrix channel I have opened this PR in hopes of adjusting that.

This makes it far easier for newcomers to find what they are looking for and also draws more attention onto the examples folders README which explains the examples in greater detail.

To make it a bit easier to properly view the adjusted structure I'd personally recommend directly looking at the checked out branch at https://github.com/AnnsAnns/RIOT/tree/restructureExamplesFolder/examples

Testing procedure

There are no required verification steps as this doesn't modify any code aside from the RIOT_BASE variable within each examples Makefile, I did however have to adjust two CI tests to properly deal with the new examples structure. One of them being a specific examples README check, the other one relying on a fixed hello-world examples path.

@github-actions github-actions bot added Area: doc Area: Documentation Area: tests Area: tests and testing framework Area: tools Area: Supplementary tools Area: examples Area: Example Applications Area: Kconfig Area: Kconfig integration labels Jan 14, 2025
@OlegHahm
Copy link
Member

I'm gonna rephrase some of my own comments from Matrix over here:
1.) Thanks a bunch for the great proposal and all the effort. It's certainly a major improvement.
2.) I think there are various dimensions on how we could substructure the examples. This PR takes pretty good care of reflecting one of them. Maybe we could introduce alternative structures using symlinks later on.
3.) For now I think this proposal could me be merged more or less as is (need to look into the details) and improvements/adjustments can be made later on.

@MrKevinWeiss
Copy link
Contributor

Could we wait until after the hard freeze, I would expect that the paths would need to be updated in the release specs as well (haven't looked into it though).

@MrKevinWeiss MrKevinWeiss added State: waiting for end of feature-freeze Process: blocked by feature freeze Integration Process: The impact of this PR is too high for merging it during soft feature freeze. labels Jan 21, 2025
@MrKevinWeiss MrKevinWeiss removed the Process: blocked by feature freeze Integration Process: The impact of this PR is too high for merging it during soft feature freeze. label Jan 21, 2025
@MrKevinWeiss
Copy link
Contributor

Freeze is over so if anyone wants to pick this up...

@mguetschow mguetschow mentioned this pull request Jan 22, 2025
Merged
@Teufelchen1 Teufelchen1 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jan 23, 2025
@riot-ci
Copy link

riot-ci commented Jan 23, 2025 •
edited
Loading

Murdock results

✔️ PASSED

55fa531 examples: restructure to use subfolders based on README structure

Success Failures Total Runtime
9359 0 9359 07m:54s

Artifacts

@Teufelchen1
Copy link
Contributor

Ah, I think you overlooked this symlinks, hence murdock is failing: https://github.com/search?q=repo%3ARIOT-OS%2FRIOT%20custom_atca_params.h&type=code

@OlegHahm
Copy link
Member

Freeze is over so if anyone wants to pick this up...

Rough consensus is to merge it ASAP. @AnnsAnns could you resolve the merge conflicts?

OlegHahm
OlegHahm approved these changes Jan 31, 2025
View reviewed changes
Copy link
Member

@OlegHahm OlegHahm left a comment

Choose a reason for hiding this comment

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

As soon as all merge conflicts are solved and the CI findings are fixed we should be ready to go. 🥳

@AnnsAnns
Copy link
Contributor Author

Hey, sorry for going dark, I was kept busy by uni-related things 😅 I will now be actively working on this again, thank you for your patience.

If everything works out this should hopefully fix the conflicts :)

@maribu
Copy link
Member

maribu commented Feb 12, 2025

@AnnsAnns Would you mind to rebase this PR, so that only commits related to the PR appear in the commit list?

@AnnsAnns
examples: restructure to use subfolders based on README structure

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
Loading
Loading status checks…
55fa531 
examples: Fix incorrect category heading

examples: shorten coap folder name

static-tests/examples: check subfolders for entries

ci/test_native: Adjust to new examples structure

examples: adjust makefiles to new structure

ci/tests: Fix symlinks to point towards proper examples
@AnnsAnns AnnsAnns force-pushed the restructureExamplesFolder branch from c99704c to 55fa531 Compare February 13, 2025 10:55
@AnnsAnns
Copy link
Contributor Author

@AnnsAnns Would you mind to rebase this PR, so that only commits related to the PR appear in the commit list?

Done, thank you for reminding me!

mguetschow
mguetschow approved these changes Feb 13, 2025
View reviewed changes
Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Thanks for doing this!

@mguetschow mguetschow enabled auto-merge February 13, 2025 11:48
@mguetschow mguetschow added this pull request to the merge queue Feb 13, 2025
Merged via the queue into RIOT-OS:master with commit 8aa0859 Feb 13, 2025
26 checks passed
mguetschow added a commit to mguetschow/RIOT that referenced this pull request Feb 13, 2025
@mguetschow
treewide: fix example references in docs
aade345 
adapt to folder structure from RIOT-OS#21135
This was referenced Feb 13, 2025
Merged
Open
mguetschow added a commit to mguetschow/RIOT that referenced this pull request Feb 14, 2025
@mguetschow
makefiles: fix output of info-applications
4c52956 
follow-up of RIOT-OS#21135
@mguetschow mguetschow mentioned this pull request Feb 14, 2025
Merged
mguetschow added a commit to mguetschow/RIOT that referenced this pull request Feb 14, 2025
@mguetschow
treewide: fix example references in docs
ca5fe72 
adapt to folder structure from RIOT-OS#21135
@mguetschow mguetschow mentioned this pull request Feb 17, 2025
Merged
@crasbe crasbe mentioned this pull request Feb 17, 2025
Open
This was referenced Feb 21, 2025
Merged
Merged
Open
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OlegHahm OlegHahm

@mguetschow mguetschow

@leandrolanzieri leandrolanzieri

@jia200x jia200x

@MrKevinWeiss MrKevinWeiss

@chrysn chrysn

@aabadie aabadie

@MichelRottleuthner MichelRottleuthner

Assignees
No one assigned
Labels
Area: doc Area: Documentation Area: examples Area: Example Applications Area: Kconfig Area: Kconfig integration Area: tests Area: tests and testing framework Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@AnnsAnns @OlegHahm @MrKevinWeiss @riot-ci @Teufelchen1 @maribu @mguetschow