Add Contributing support / Improve Getting Started / minor clean-up#55
Open
hdub-tech wants to merge 12 commits intoschlpr0k:mainfrom
Open
Add Contributing support / Improve Getting Started / minor clean-up#55hdub-tech wants to merge 12 commits intoschlpr0k:mainfrom
hdub-tech wants to merge 12 commits intoschlpr0k:mainfrom
Conversation
hdub-tech
added
documentation
hdub-tech
force-pushed
the
feature/contributing-support
branch
from
c0fcb59 to
a9b6321
Compare
hdub-tech
force-pushed
the
feature/contributing-support
branch
from
6436dc9 to
e0ee906
Compare
hdub-tech
changed the title
hdub-tech
commented
Aug 2, 2025
Comment on lines
+65
to
+72
| ### System Requirements | ||
|
|
||
| IronJump is lightweight and can operate with minimum OS system requirements. The | ||
| following represents the suggested system requirements for running on Ubuntu. | ||
|
|
||
| * CPUs: 1 | ||
| * Memory: 4GB | ||
| * Disk space: 10GB (If headless) |
Collaborator
Author
There was a problem hiding this comment.
Spot check these Sys reqs for me please @schlpr0k
Comment on lines
+101
to
+111
| <!-- | ||
| See sample release notes here: https://git.k8s.io/community/contributors/guide/release-notes.md | ||
| - If no release note is needed, write 'None' | ||
| - If you would like us to create one, write 'SUGGESTIONS_WELCOME' | ||
| - If this PR contains multiple Release Note worthy items, put one per line in | ||
| the block (Next time, try to break it up into multiple PRs, but we have | ||
| definitely all done it before, so no worries!) | ||
| --> | ||
| ```release-note | ||
| ONE_LINE_RELEASE_NOTE_HERE | ||
| ``` |
Collaborator
Author
There was a problem hiding this comment.
I took this idea from the buildah project, which has automation that parses out release notes, which I thought I would explore in the future
Collaborator
Author
There was a problem hiding this comment.
This document should contain all the knowledge on how to use everything added with this PR. If you read one thing, let it be this. (Click the ... > View File to see it in Markdown format)
Comment on lines
+7
to
+13
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - '**/*.sh' | ||
| workflow_dispatch: |
Collaborator
Author
There was a problem hiding this comment.
This lint workflow will run in two scenarios:
- When a PR is opened against main with changes to *.sh files
- If someone navigates to Actions > Linting > and clicks "Run Workflow"
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist
What this PR does / why we need it
Tip
While this PR DOES utilize the new PR Template, it is a poor example of breaking up work, even if it really does meet the (mostly) singular goal of adding support for Contributors to resolve #54. Try to be better than me in breaking up work. 😅
This pull request:
.gitignorewhich ignores.vagrantand*.swpfunctionstofunctions.shfor quick identification and to ease automation and linting, and updates referencesUser facing changes
None (all changes are "under the hood")
Contributor facing changes
The following shows some of the contributor facing changes introduced in this PR
.gitignore file for *.swp and .vagrant:
Update PR Template:
Notes for the reviewer
functionstofunctions.shstemmed from a previous discussion (Rename main files based on types #2), but came to the forefront when writing the linter script. It allows for using afindon*.shfiles without needing to hardcode filenames. This tactic was also used in provisioning the new Vagrant VMs.Testing / How to verify it
Note
Tests for the following were excluded because they are physically not testable until after this PR is merged.
readprompt still works after shellcheck cleanup on SERVER with Ubuntu 24.04 (VM)Details
Steps:
ironjumpshortcutsudo /opt/IronJump/IronJump.shto be prompted to press ENTER to continueScreencast from 2025-07-26 00-09-13.webm
readprompt still works after shellcheck cleanup, and now displays the correct git url on SERVER with Ubuntu 24.04 (VM)Details
Steps:
autosshdirectorysudo ironjumpto be scolded and observe the corrected URLScreencast from 2025-07-26 00-58-34.webm
functionsscript did not have adverse effects on SERVER or ENDPOINT with Ubuntu 24.04 (VM)Details
Steps:
Follow steps in CONTRIBUTING guide section "Development/Test Environment setup" to set-up a Server and register an Endpoint with it.
Observe Server and Endpoint set-up is successful
Server, with endpoint connected
Endpoint, connected to server
pre-commit.shscript works when run manually with no arguments,-harg,-s SHELLCHECK_FORMATarg, and fails as expected with various negative cases, and passes linterDetails
pre-commit.shscript works as a git hook to block commits (Even though project is not at stage to recommend this usage yet)Details
Release Note
All changes are either under the hood or contributor facing only.