feat(github action): Initialize repository with GitHub Action and ancillary configuration & documentation

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@speckle.systems. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Speckle Contribution Guidelines
+
+## Introduction
+
+Thank you for reading this! Speckle's a rather wide network of parts that depend on each other, either directly, indirectly or even just cosmetically.
+
+> **Speckle** is a quite large ecosystem of moving parts. Any changes may have unintended effects, that can cause problems quickly for many people (and processes) that rely on Speckle.
+
+This means that what might look like a simple quick change in one repo may have a big hidden cost that propagates around other parts of the project. We're all here to help each other, and this guide is meant to help you get started and promote a framework that can untangle all these dependecies through discussion!
+
+## Bugs & Issues 🐞
+
+### Found a new bug?
+
+- First step is to check whether this is a new bug! We encourage you to search through the issues of the project in question **and** associated repos!
+
+- If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem.
+
+- Can't mention this often enough: tells us how to reproduce the problem! We will ignore or flag as such issues without reproduction steps.
+
+- Try to reference & note all potentially affected projects.
+
+### Sending a PR for Bug Fixes
+
+You fixed something! Great! We hope you logged it first :) Make sure though that you've covered the lateral thinking needed for a bug report, as described above, also in your implementation! If there any tests, make sure they all pass. If there are none, it means they're missing - so add them!
+
+## New Features 🎉
+
+The golden rule is to Discuss First!
+
+- Before embarking on adding a new feature, suggest it first as an issue with the `enhancement` label and/or title - this will allow relevant people to pitch in
+- We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem.
+- The last step is to actually start writing code & submit a PR so we can follow along!
+- All new features should, if and where possible, come with tests. We won't merge without!
+
+> Many clients may potentially have overlapping scopes, some features might already be in dev somewhere else, or might have been postponed to the next major release due to api instability in that area. For example, adding a delete stream button in the accounts panel in rhino: this feature was planned for speckle admin, and the whole functionality of the accounts panel in rhino is to be greatly reduced!
+
+## Cosmetic Patches ✨
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability or functionality of Speckle **will generally not be accepted**.
+
+Why? However trivial the changes might seem, there might be subtle reasons for the original code to be as it is. Furthermore, there are a lot of potential hidden costs (that even maintainers themselves are not aware of fully!) and they eat up review time unncessarily.
+
+> **Examples**: modifying the colour of an UI element in one client may have a big hidden cost and need propagation in several other clients that implement a similar ui element. Changing the default port or specifiying `localhost` instead of `0.0.0.0` breaks cross-vm debugging and developing.
+
+## Wrap up
+
+Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion on our community [forum](https://discourse.speckle.works).
+
+🙌❤️💙💚💜🙌

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,113 @@
+---
+name: Bug report
+about: Help improve Speckle!
+title: ''
+labels: bug
+assignees: ''
+---
+
+<!---
+
+Provide a short summary in the Title above. Examples of good Issue titles:
+
+* "Bug: Error from server when reticulating splines"
+* "Bug: Revit crashes when installing connector"
+
+-->
+
+## Prerequisites
+
+<!---
+
+Please answer the following questions before submitting an issue.
+
+-->
+
+- [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)
+- [ ] I checked the [documentation](https://speckle.guide/) and found no answer.
+- [ ] I checked [existing issues](../issues?q=is%3Aissue) and found no similar issue. <!-- If you do find an existing issue, please show your support by liking it :+1: instead of creating a new issue -->
+- [ ] I checked the [community forum](https://speckle.community/) for related discussions and found no answer.
+- [ ] I'm reporting the issue to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories))
+
+## What package are you referring to?
+
+<!---
+Is it related to the server (backend) only, or does this bug relate to the frontend, viewer, objectloader or any other package?
+-->
+
+## Describe the bug
+
+<!---
+A clear and concise description of what the bug is.
+-->
+
+## To Reproduce
+
+<!---
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+-->
+
+## Expected behavior
+
+<!---
+A clear and concise description of what you expected to happen.
+-->
+
+## Screenshots
+
+<!---
+If applicable, add screenshots to help explain your problem.
+-->
+
+## System Info
+
+If applicable, please fill in the below details - they help a lot!
+
+### Desktop (please complete the following information):
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+### Smartphone (please complete the following information):
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+## Failure Logs
+
+<!---
+Please include any relevant log snippets or files here, or upload as a file.
+
+If including inline, please use markdown code block syntax. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks
+For example:
+
+```
+your log output here
+```
+-->
+
+## Additional context
+
+<!---
+Add any other context about the problem here.
+-->
+
+## Proposed Solution (if any)
+
+<!---
+Let us know what how you would solve this.
+-->
+
+#### Optional: Affected Projects
+
+<!---
+Does this issue propagate to other dependencies or dependents? If so, list them here with links!
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,71 @@
+---
+name: Feature request
+about: Suggest an idea for Speckle!
+title: ''
+labels: enhancement, question
+assignees: ''
+---
+
+<!---
+
+Provide a short summary in the Title above. Examples of good Issue titles:
+
+* "Enhancement: Connector for Minecraft"
+* "Enhancement: Web viewer should support tesseracts"
+
+-->
+
+## Prerequisites
+
+<!---
+
+Please answer the following questions before submitting an issue.
+
+-->
+
+- [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)
+- [ ] I checked the [documentation](https://speckle.guide/) and found no answer.
+- [ ] I checked [existing issues](../issues?q=is%3Aissue) and found no similar issue. <!-- If you do find an existing issue, please show your support by liking it :+1: instead of creating a new issue -->
+- [ ] I checked the [community forum](https://speckle.community/) for related discussions and found no answer.
+- [ ] I'm requesting the feature to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories))
+
+## What package are you referring to?
+
+<!---
+Is it related to the server (backend) only, or does this feature request relate to the frontend, viewer, objectloader or any other package?
+-->
+
+## Is your feature request related to a problem? Please describe.
+
+<!---
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+-->
+
+## Describe the solution you'd like
+
+<!---
+A clear and concise description of what you want to happen.
+-->
+
+## Describe alternatives you've considered
+
+<!---
+A clear and concise description of any alternative solutions or features you've considered.
+-->
+
+## Additional context
+
+<!---
+Add any other context or screenshots about the feature request here.
+
+Have you seen this feature implemented in any other software?  Can you provide screenshots or links to video or documentation?
+What works well about these existing features in other software?  What doesn't work well?
+-->
+
+## Related issues or community discussions
+
+<!---
+Is this feature request related to (but sufficiently distinct from) any existing issues?
+Does this feature request require other features to be available beforehand?
+Has this feature been discussed in the community forum, please link here? https://speckle.community/
+-->

.github/ISSUE_TEMPLATE/papercut.md

@@ -0,0 +1,7 @@
+---
+name: Papercut
+about: Small annoyances and issues that are not technically bugs
+title: ''
+labels: '✂️ paper-cut'
+assignees: ''
+---

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: daily

.github/pull_request_template.md

@@ -0,0 +1,102 @@
+<!---
+
+Provide a short summary in the Title above. Examples of good PR titles:
+
+* "Feature: adds metrics to component"
+
+* "Fix: resolves duplication in comment thread"
+
+* "Update: apollo v2.34.0"
+
+-->
+
+## Description & motivation
+
+<!---
+
+Describe your changes, and why you're making them.  What benefit will this have to others?
+
+Is this linked to an open Github issue, a thread in Speckle community,
+or another pull request? Link it here.
+
+If it is related to a Github issue, and resolves it, please link to the issue number, e.g.:
+Fixes #85, Fixes #22, Fixes username/repo#123
+Connects #123
+
+-->
+
+## Changes:
+
+<!---
+
+- Item 1
+- Item 2
+
+-->
+
+## To-do before merge:
+
+<!---
+
+(Optional -- remove this section if not needed)
+
+Include any notes about things that need to happen before this PR is merged, e.g.:
+
+- [ ] Change the base branch
+
+- [ ] Ensure PR #56 is merged
+
+-->
+
+## Screenshots:
+
+<!---
+
+Include a screenshot the before and after.  This can be a screenshot of a plugin, web frontend, or output in a terminal.
+
+-->
+
+## Validation of changes:
+
+<!---
+
+Describe what tests have been added or amended, and why these demonstrate it works and will prevent this feature being accidentally broken by future changes.
+
+-->
+
+## Checklist:
+
+<!---
+
+This checklist is mostly useful as a reminder of small things that can easily be
+
+forgotten – it is meant as a helpful tool rather than hoops to jump through.
+
+Put an `x` between the square brackets, e.g. [x], for all the items that apply,
+
+make notes next to any that haven't been addressed, and remove any items that are not relevant to this PR.
+
+-->
+
+- [ ] My pull request follows the guidelines in the [Contributing guide](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)?
+- [ ] My pull request does not duplicate any other open [Pull Requests](../../pulls) for the same update/change?
+- [ ] My commits are related to the pull request and do not amend unrelated code or documentation.
+- [ ] My code follows a similar style to existing code.
+- [ ] I have added appropriate tests.
+- [ ] I have updated or added relevant documentation.
+
+## References
+
+<!---
+
+(Optional -- remove this section if not needed )
+
+Include **important** links regarding the implementation of this PR.
+
+This usually includes a RFC or an aggregation of issues and/or individual conversations
+
+that helped put this solution together. This helps ensure we retain and share knowledge
+
+regarding the implementation, and may help others understand motivation and design decisions etc..
+
+-->

.github/workflows/close-issue.yml

@@ -0,0 +1,13 @@
+name: Update issue Status
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  update_issue:
+    uses: specklesystems/github-actions/.github/workflows/project-add-issue.yml@main
+    secrets: inherit
+    with:
+      issue-id: ${{ github.event.issue.node_id }}
+      project-number: 19

.github/workflows/open-issue.yml

@@ -0,0 +1,13 @@
+name: Move new issues into Project
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  track_issue:
+    uses: specklesystems/github-actions/.github/workflows/project-add-issue.yml@main
+    secrets: inherit
+    with:
+      issue-id: ${{ github.event.issue.node_id }}
+      project-number: 19

.github/workflows/pre-commit.yml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v3.0.0

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 'v4.4.0'
+    hooks:
+      - id: check-yaml
+        args:
+          - --allow-multiple-documents
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-vcs-permalinks
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: https://github.com/specklesystems/pre-commit
+    rev: '0.2.0'
+    hooks:
+      - id: ggshield-not-ci
+        name: ggshield

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 AEC Systems
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,150 @@
+# Speckle Automate GitHub Composite Action
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/)
+
+## Introduction
+
+This repository contains the source code for the Speckle Automate GitHub Composite Action. It is a GitHub Action that registers, builds, and publishes a [Speckle Automate](https://speckle.systems) [Function](https://speckle.guide).
+
+## Documentation
+
+### Inputs
+
+#### `speckle_automate_github_action_token`
+
+*Required.* GitHub [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) which allows Git Pull permissions to the [Speckle Automate GitHub Action](https://github.com/specklesystems/speckle-automate-github-action) repository.
+<!-- TODO: remove when we publish the Speckle Automate GitHub Action -->
+
+#### `speckle_server_url`
+
+Speckle Automate URL which we will publish our Function to. Should include the `https://` protocol and not end with a trailing slash. **The token must be stored in GitHub as an [encrypted secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets)**
+
+Defaults to [`https://automate.speckle.dev`](https://automate.speckle.dev). <!-- TODO update when we release production server -->
+
+#### `speckle_token`
+
+The Speckle Automate API token to use to publish the function. This token must have `functions:write` permissions.
+
+**This must be stored in GitHub as an [encrypted secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets)**. This token must be protected, as it allows anyone with access to it to publish functions as you to Speckle Automate.
+
+If you believe your token has been compromised, please revoke it immediately on your [Speckle Automate Server](https://automate.speckle.dev/tokens). Please also audit your Speckle Automate Function changes to ensure that they were not made by an unauthorized party.
+
+Please note that this is not a Speckle Account token, but a **Speckle Automate API** token. You can create one by logging into the [Speckle Automate Server](https://automate.speckle.dev) and going to the [API Tokens](https://automate.speckle.dev/tokens) page.
+
+#### `speckle_function_id`
+
+*Required.* The unique identifier of the function. Go to Speckle Automate to register your Function and get its Identifier.
+
+Your Speckle Token must have write permissions for the Speckle Function with this ID, otherwise the publish will fail.
+
+#### `speckle_function_path`
+
+The path to the Speckle Automate Function to publish. This path is relative to the root of the repository. If you provide a path to a directory, your Speckle Automate Function must be in a file named `specklefunction.yaml` within that directory.
+
+Defaults to the root of the repository.
+
+#### `speckle_function_input_schema`
+
+The path to a file containing a JSON Schema. This JSON Schema defines the parameters required by the Function. The JSON Schema will be used to automatically create the User Interface displayed to users of your Function in Speckle Automate. Users will be able to provide their data to customise the Function.
+
+Defaults to `./input-schema.json`
+
+#### `speckle_function_command`
+
+*Required.* The command to run to execute the function in a runtime environment.
+
+For example, if you are using Python, you might use `python3 main.py`. If you are using Node.js, you might use `node main.js`. If using bash shell, `bash main.sh` etc. etc..  Even if the command is defined within your Dockerfile (for examples, using the `CMD` or `ENTRYPOINT` statements), you must provide the command here in order for Speckle Automate to run the function.
+
+#### `dockerfile_path`
+
+Path to the Dockerfile to be used to build the Speckle Function.
+
+Defaults to `./Dockerfile`
+
+#### `docker_context`
+
+Path to the directory containing the build context for the Docker image. This is typically the root of the repository, or the directory containing the Dockerfile.
+
+Defaults to `./`, the root of the repository.
+
+### Outputs
+
+This GitHub Action does not have any outputs. Please instead inspect the logs to see the result of the action, and view the results on Speckle Automate.
+
+### Example usage
+
+#### Publish a Speckle Function, and build the Docker Image using Docker
+
+1. You will first need to create the required secrets and [store them in GitHub Actions](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
+    - `SPECKLE_AUTOMATE_GITHUB_ACTION_TOKEN`: This is only temporarily required until the GitHub Action is made public and published. This is a GitHub [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) with git read permissions to the [Speckle Automate GitHub Action](https://github.com/specklesystems/speckle-automate-github-action) repository. <!-- TODO: remove once we have published the GitHub Action -->
+    - `SPECKLE_FUNCTION_PUBLISH_TOKEN`: Please note that this is not a Speckle Account token, but a **Speckle Automate API** token. You can create one by logging into the [Speckle Automate Server](https://automate.speckle.dev) and going to the [API Tokens](https://automate.speckle.dev/tokens) page.
+
+1. You will need to create a GitHub Actions workflow file. You can create a new workflow file, `.github/workflows/speckle-automate.yml`, in your repository.
+
+1. You will need to add the following to your workflow file, replacing `XXXXXXXXXX` with your Speckle Function ID, and `echo "Hello World!"` with your Speckle Function command:
+
+    ```yaml
+    name: Speckle Function CI
+
+    on:
+      push:
+        branches:
+          - 'main'
+
+    jobs:
+      docker:
+        runs-on: ubuntu-latest
+        steps:
+          -
+            name: Register, Build, and Publish a Speckle Function
+            uses: specklesystems/speckle-automate-github-composite-action
+            with:
+              speckle_automate_github_action_token: ${{ secrets.SPECKLE_AUTOMATE_GITHUB_ACTION_TOKEN }} # TODO: remove once we have published the GitHub Action
+              speckle_token: ${{ secrets.SPECKLE_FUNCTION_PUBLISH_TOKEN }}
+              speckle_function_id: XXXXXXXXXX # <-- REPLACE WITH YOUR SPECKLE FUNCTION ID
+              speckle_function_command: 'echo "Hello World!"' # <-- REPLACE WITH YOUR SPECKLE FUNCTION COMMAND
+    ```
+
+1. And that's it! Now commit to your repository `main` branch, and you should see a new version of your Speckle Function registered in Speckle Automate!
+
+## Developing & Debugging
+
+### Running locally
+
+This is a GitHub Action, intended to be run within GitHub Actions. It is not intended to be run locally.
+
+### Developing
+
+#### Prerequisites to developing
+
+- [Pre-Commit](https://pre-commit.com/#install)
+
+1. Clone this repository
+1. Run `pre-commit install` to install the pre-commit hooks
+
+#### Testing
+
+There are no unit tests as this is a GitHub Action. You can test the action by running it in a GitHub Actions workflow.
+
+#### Linting
+
+1. Run `yarn precommit` to run all pre-commit hooks.
+1. You must address all linting errors prior to committing changes. The CI will fail if there are any linting errors, and you will be unable to merge your PR.
+
+## Contributing
+
+Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) for an overview of the practices we try to follow.
+
+## Community
+
+The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!
+
+## Security
+
+For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
+
+## License
+
+Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems).
+
+## Acknowledgements

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 2.2.+   | :white_check_mark: |
+| < 2.2   | :x:                |
+
+## Reporting a Vulnerability
+
+Hi! If you've found something off, we'd be more than happy if you would report it via security@speckle.systems. We will work together with you to correctly identify the cause and implement a fix. Thanks for helping make Speckle safer!

action.yml

@@ -0,0 +1,69 @@
+name: 'Speckle Automate - Build and Publish'
+description: 'Run actions for commits to Speckle Automate Functions, to build and publish them.'
+author: 'specklesystems'
+inputs:
+  speckle_automate_github_action_token: #TODO remove this input when we publish the Speckle Automate GitHub Action. This is only required while the repository is private and the action unpublished.
+    description: 'GitHub Token which allows Git Pull permissions to the Speckle Automate GitHub Action repository. **The token must be stored in GitHub as an encrypted secret**.'
+    required: true
+  speckle_server_url: #FIXME change to speckle_automate_url
+    description: 'Speckle Automate URL. Should include the `https://` protocol and not end with a trailing slash.'
+    required: false
+    default: 'https://automate.speckle.dev' #TODO change to https://automate.speckle.systems
+  speckle_token:
+    description: 'Token for authentication to Speckle Automate Server, allowing publishing of Speckle Functions. **The token must be stored in GitHub as an encrypted secret**.'
+    required: true
+  speckle_function_id:
+    description: 'The unique identifier of the function. Go to Speckle Automate to register your Function and get its Identifier.'
+    required: true
+  speckle_function_path:
+    description: 'Path to the Speckle Function definition (`specklefunction.yaml`) to be published.'
+    required: false
+    default: '.' # root directory of the checked out source code
+  speckle_function_input_schema:
+    description: 'JSON Schema defining the parameters required by the Function. These will be used to create the User Interface displayed to users of your Function in Speckle Automate. Users will be able to provide their data to customise the Function.'
+    required: false
+    default: './input-schema.json'
+  speckle_function_command:
+    description: 'The command to run to execute the function in a runtime environment.'
+    required: true
+  dockerfile_path:
+    description: 'Path to the Dockerfile to be used to build the Speckle Function.'
+    required: false
+    default: './Dockerfile'
+  docker_context:
+    description: 'Path to the directory containing the build context for the Docker image.'
+    required: false
+    default: '.' # root directory of the checked out source code
+runs:
+  using: "composite"
+  steps:
+      - uses: actions/checkout@v3.5.3 # checkout the repository in which this GitHub Action is being used.
+      - uses: actions/checkout@v3.5.3 # checkout the Speckle Automate GitHub Action repository. This entire step is required while the repository is private and the action unpublished.
+        with:
+          repository: 'specklesystems/speckle-automate-github-action'
+          path: 'github-action' # location where the repository is checked out to.
+          ref: 'main'
+          token: ${{ inputs.speckle_automate_github_action_token }}
+      - name: 'Registers the version of the Speckle Function which is about to be published.'
+        id: register-speckle-function-version
+        uses: ./github-action # use the action from the local repo
+        with:
+          speckle_server_url: ${{ input.speckle_server_url }}
+          speckle_token: ${{ input.speckle_token }}
+          speckle_function_id: ${{ input.speckle_function_id }}
+          speckle_function_path: ${{ input.speckle_function_path }}
+          speckle_function_input_schema: ${{ input.speckle_function_input_schema }}
+          speckle_function_command: ${{ input.speckle_function_command }}
+      - name: Log in to Speckle Automate Docker registry
+        uses: docker/login-action@v2.2.0
+        with:
+          registry: ${{ input.speckle_server_url }}
+          username: ${{ input.speckle_token }}
+          password: ${{ input.speckle_token }}
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4.1.1
+        with:
+          context: ${{ input.docker_context }}
+          file: ${{ input.dockerfile_path }}
+          tags: ${{ input.speckle_server_url }}/${{ input.speckle_function_id }}:${{ steps.register-speckle-function-version.outputs.version_id }}
+          push: true