diff --git a/.vale/styles/RedHat/Abbreviations.yml b/.vale/styles/RedHat/Abbreviations.yml index 70308d9..c5cc51d 100644 --- a/.vale/styles/RedHat/Abbreviations.yml +++ b/.vale/styles/RedHat/Abbreviations.yml @@ -4,6 +4,5 @@ level: error link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/abbreviations/ message: "Do not use periods in all-uppercase abbreviations such as '%s'." nonword: true -source: "IBM - Periods with abbreviations, p. 5" tokens: - '\b(?:[A-Z]\.){3,5}' diff --git a/.vale/styles/RedHat/CaseSensitiveTerms.yml b/.vale/styles/RedHat/CaseSensitiveTerms.yml index b9a440e..d32f82b 100644 --- a/.vale/styles/RedHat/CaseSensitiveTerms.yml +++ b/.vale/styles/RedHat/CaseSensitiveTerms.yml @@ -4,7 +4,6 @@ ignorecase: false level: error link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/ message: Use '%s' rather than '%s'. -source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions" action: name: replace swap: diff --git a/.vale/styles/RedHat/Conjunctions.yml b/.vale/styles/RedHat/Conjunctions.yml index aab59b2..651607b 100644 --- a/.vale/styles/RedHat/Conjunctions.yml +++ b/.vale/styles/RedHat/Conjunctions.yml @@ -4,7 +4,6 @@ level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/conjunctions/ message: "Do not overuse beginning sentences with '%s'." scope: paragraph -source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/Conjunctions.yml action: name: remove tokens: diff --git a/.vale/styles/RedHat/ConsciousLanguage.yml b/.vale/styles/RedHat/ConsciousLanguage.yml index 86a1cc6..2cc8aa2 100644 --- a/.vale/styles/RedHat/ConsciousLanguage.yml +++ b/.vale/styles/RedHat/ConsciousLanguage.yml @@ -4,7 +4,6 @@ ignorecase: true level: warning link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/consciouslanguage/ message: Use '%s' rather than '%s.' -source: "https://redhat-documentation.github.io/supplementary-style-guide/#conscious-language" action: name: replace swap: diff --git a/.vale/styles/RedHat/Contractions.yml b/.vale/styles/RedHat/Contractions.yml index fd3cc74..dd2ea21 100644 --- a/.vale/styles/RedHat/Contractions.yml +++ b/.vale/styles/RedHat/Contractions.yml @@ -4,7 +4,6 @@ ignorecase: true level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/contractions/ message: "Avoid contractions. Use '%s' rather than '%s.'" -source: "https://redhat-documentation.github.io/supplementary-style-guide/#contractions" action: name: replace swap: diff --git a/.vale/styles/RedHat/Definitions.yml b/.vale/styles/RedHat/Definitions.yml index 56e0c9c..614dbc6 100644 --- a/.vale/styles/RedHat/Definitions.yml +++ b/.vale/styles/RedHat/Definitions.yml @@ -4,7 +4,6 @@ ignorecase: false level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/definitions/ message: "Define acronyms and abbreviations (such as '%s') on first occurrence if they're likely to be unfamiliar." -source: "IBM - Abbreviations, p. 1" # Ensures that the existence of 'first' implies the existence of 'second'. first: '\b([A-Z]{3,5}s?)\b' second: '\(([A-Z]{3,5}s?)\)' diff --git a/.vale/styles/RedHat/Ellipses.yml b/.vale/styles/RedHat/Ellipses.yml index e2cc703..fc4777a 100644 --- a/.vale/styles/RedHat/Ellipses.yml +++ b/.vale/styles/RedHat/Ellipses.yml @@ -4,7 +4,6 @@ level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/ellipses/ message: "Avoid the ellipsis (...) except to indicate omitted words." nonword: true -source: "IBM - Ellipses, p.49" action: name: remove tokens: diff --git a/.vale/styles/RedHat/HeadingPunctuation.yml b/.vale/styles/RedHat/HeadingPunctuation.yml index 6b9c43a..268e96d 100644 --- a/.vale/styles/RedHat/HeadingPunctuation.yml +++ b/.vale/styles/RedHat/HeadingPunctuation.yml @@ -5,7 +5,6 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guid message: "Do not use end punctuation in headings." nonword: true scope: heading -source: "IBM - Periods in headings and titles, p. 61" action: name: edit params: diff --git a/.vale/styles/RedHat/Headings.yml b/.vale/styles/RedHat/Headings.yml index f4e2c97..18737cf 100644 --- a/.vale/styles/RedHat/Headings.yml +++ b/.vale/styles/RedHat/Headings.yml @@ -5,7 +5,6 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guid match: $sentence message: "Use sentence-style capitalization in '%s'." scope: heading -source: "IBM - Capitalization in headings and titles, p.16" indicators: - ":" exceptions: @@ -173,4 +172,4 @@ exceptions: - Yana - Yeoman - Zowe - - GitLab Code Quality \ No newline at end of file + - GitLab Code Quality diff --git a/.vale/styles/RedHat/OxfordComma.yml b/.vale/styles/RedHat/OxfordComma.yml index 794d2f1..0518015 100644 --- a/.vale/styles/RedHat/OxfordComma.yml +++ b/.vale/styles/RedHat/OxfordComma.yml @@ -3,6 +3,5 @@ extends: existence level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/oxfordcomma/ message: "Use the Oxford comma in '%s'." -source: "IBM - Commas between clauses, p.45" tokens: - '(?:[^,]+,){1,}\s\w+\sand' diff --git a/.vale/styles/RedHat/PassiveVoice.yml b/.vale/styles/RedHat/PassiveVoice.yml index 91ffa17..49cac6a 100644 --- a/.vale/styles/RedHat/PassiveVoice.yml +++ b/.vale/styles/RedHat/PassiveVoice.yml @@ -4,7 +4,6 @@ ignorecase: true level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/passivevoice/ message: "'%s' is passive voice. Consider rewording in active voice. You can use the passive voice in prerequisites" -source: "https://redhat-documentation.github.io/supplementary-style-guide/#prerequisites; IBM - Voice, p.35" raw: - \b(am|are|were|being|is|been|was|be)\b\s* tokens: diff --git a/.vale/styles/RedHat/ReleaseNotes.yml b/.vale/styles/RedHat/ReleaseNotes.yml index 05add68..8045e06 100644 --- a/.vale/styles/RedHat/ReleaseNotes.yml +++ b/.vale/styles/RedHat/ReleaseNotes.yml @@ -4,7 +4,6 @@ ignorecase: false level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/releasenotes/ message: "For release notes, consider using '%s' rather than '%s'." -source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes" # swap maps tokens in form of bad: good swap: Now: With this update diff --git a/.vale/styles/RedHat/SentenceLength.yml b/.vale/styles/RedHat/SentenceLength.yml index 3053bbd..64bfaa2 100644 --- a/.vale/styles/RedHat/SentenceLength.yml +++ b/.vale/styles/RedHat/SentenceLength.yml @@ -4,6 +4,5 @@ level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/sentencelength/ message: "Try to keep sentences to an average of 32 words or fewer." scope: sentence -source: "IBM - Conversational style" max: 32 token: \b(\w+)\b diff --git a/.vale/styles/RedHat/SimpleWords.yml b/.vale/styles/RedHat/SimpleWords.yml index 97c53c9..30d9f07 100644 --- a/.vale/styles/RedHat/SimpleWords.yml +++ b/.vale/styles/RedHat/SimpleWords.yml @@ -4,7 +4,6 @@ ignorecase: true level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/simplewords/ message: "Use simple language. Consider using '%s' rather than '%s'." -source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm" swap: "approximate(?:ly)?": about "objective(?! C?)": aim|goal diff --git a/.vale/styles/RedHat/Slash.yml b/.vale/styles/RedHat/Slash.yml index 76f61a0..26fef4c 100644 --- a/.vale/styles/RedHat/Slash.yml +++ b/.vale/styles/RedHat/Slash.yml @@ -4,7 +4,6 @@ ignorecase: true level: warning link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/slash/ message: "Use either 'or' or 'and' in '%s'" -source: "IBM - Slashes, p. 68" tokens: - '\w+/\w+' exceptions: diff --git a/.vale/styles/RedHat/Spacing.yml b/.vale/styles/RedHat/Spacing.yml index 3f12b33..7f01ffc 100644 --- a/.vale/styles/RedHat/Spacing.yml +++ b/.vale/styles/RedHat/Spacing.yml @@ -4,7 +4,6 @@ level: error link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spacing/ message: "Keep one space beween words in '%s'." nonword: true -source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods tokens: - "[a-z][.?!] {2,}[A-Z]" - "[a-z][.?!][A-Z]" diff --git a/.vale/styles/RedHat/Spelling.yml b/.vale/styles/RedHat/Spelling.yml index 7b76f32..8278290 100644 --- a/.vale/styles/RedHat/Spelling.yml +++ b/.vale/styles/RedHat/Spelling.yml @@ -3,7 +3,6 @@ extends: spelling level: warning link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spelling/ message: "Use correct American English spelling. Did you really mean '%s'?" -source: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spelling/ # A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking. # Spelling rule applies to individual words filters: diff --git a/.vale/styles/RedHat/TermsErrors.yml b/.vale/styles/RedHat/TermsErrors.yml index c630e22..8411cfd 100644 --- a/.vale/styles/RedHat/TermsErrors.yml +++ b/.vale/styles/RedHat/TermsErrors.yml @@ -4,7 +4,6 @@ ignorecase: true level: error link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termserrors/ message: "Use '%s' rather than '%s'." -source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300" action: name: replace # swap maps tokens in form of bad: good @@ -215,7 +214,6 @@ swap: on-premise: on-premises|off-premises|onsite|offsite on-ramp: access method op-code: opcode - open-source|OpenSource|opensource: open source organise: organize organised: organized organising: organizing diff --git a/.vale/styles/RedHat/TermsSuggestions.yml b/.vale/styles/RedHat/TermsSuggestions.yml index e579ecf..daa4bb6 100644 --- a/.vale/styles/RedHat/TermsSuggestions.yml +++ b/.vale/styles/RedHat/TermsSuggestions.yml @@ -4,7 +4,6 @@ ignorecase: false level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termssuggestions/ message: "Depending on the context, consider using '%s' rather than '%s'." -source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300" action: name: replace swap: diff --git a/.vale/styles/RedHat/TermsWarnings.yml b/.vale/styles/RedHat/TermsWarnings.yml index 035f5f3..05fb5dc 100644 --- a/.vale/styles/RedHat/TermsWarnings.yml +++ b/.vale/styles/RedHat/TermsWarnings.yml @@ -4,7 +4,6 @@ ignorecase: true level: warning link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termswarnings/ message: "Consider using '%s' rather than '%s' unless updating existing content that uses it." -source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300" action: name: replace swap: diff --git a/.vale/styles/RedHat/Usage.yml b/.vale/styles/RedHat/Usage.yml index 410f98c..b55e306 100644 --- a/.vale/styles/RedHat/Usage.yml +++ b/.vale/styles/RedHat/Usage.yml @@ -4,7 +4,6 @@ ignorecase: true level: suggestion link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/usage/ message: "Verify your use of '%s' with the word usage guidelines." -source: "https://redhat-documentation.github.io/supplementary-style-guide/glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300" tokens: - "pop-up (?:help|menu)" - "redbook(:s)?" diff --git a/README.md b/README.md index 5972b58..93e150e 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ Gosmee is a versatile webhook relayer that can be conveniently executed anywhere ## Description -Gosmee enables you to relay webhooks from either itself (as a server) or from https://smee.io to your local notebook. +Gosmee enables you to relay webhooks from either itself (as a server) or from to your local notebook. With gosmee, you can effortlessly expose the service on your local network or behind a VPN, allowing a public service (such as GitHub) to push webhooks to it. -For instance, if you configure your GitHub Webhook to direct to a https://smee.io/ URL or where gosmee server is listening, you can then use the gosmee client on your local notebook to obtain the events from the server and forward them to the local service, thereby establishing a connection between the GitHub webhook and your local service on your workstation. +For instance, if you configure your GitHub Webhook to direct to a URL or where gosmee server is listening, you can then use the gosmee client on your local notebook to obtain the events from the server and forward them to the local service, thereby establishing a connection between the GitHub webhook and your local service on your workstation. ### Diagram @@ -101,14 +101,16 @@ source <(gosmee completion zsh) ## Usage ### Client -If you intend to use https://smee.io, you might want to generate your own smee URL by visiting https://smee.io/new. + +If you intend to use , you might want to generate your own smee URL by visiting . Once you have it, the basic usage is as follows: ```shell gosmee client https://smee.io/aBcDeF https://localhost:8080 ``` -This command will relay all payloads received at the smee URL to a service running on http://localhost:8080. + +This command will relay all payloads received at the smee URL to a service running on . Another option is to save all the relays as shell script that can be replayed without having to recreate the event: