Merge pull request #3 from actions/sgoedecke/initial-setup

Setup initial inference flow and install packages

Author: sgoedecke

.env.example

@@ -9,7 +9,7 @@ ACTIONS_STEP_DEBUG=true
 
 # GitHub Actions inputs should follow `INPUT_<name>` format (case-sensitive).
 # Hyphens should not be converted to underscores!
-INPUT_MILLISECONDS=2400
+INPUT_PROMPT=hello
 
 # GitHub Actions default environment variables. These are set for every run of a
 # workflow and can be used in your actions. Setting the value here will override

.github/workflows/ci.yml

@@ -10,6 +10,7 @@ on:
 
 permissions:
   contents: read
+  models: read
 
 jobs:
   test-typescript:
@@ -43,6 +44,8 @@ jobs:
       - name: Test
         id: npm-ci-test
         run: npm run ci-test
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
 
   test-action:
     name: GitHub Actions Test
@@ -57,8 +60,10 @@ jobs:
         id: test-action
         uses: ./
         with:
-          milliseconds: 2000
+          prompt: hello
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
 
       - name: Print Output
         id: output
-        run: echo "${{ steps.test-action.outputs.time }}"
+        run: echo "${{ steps.test-action.outputs.response }}"

.github/workflows/licensed.yml

@@ -8,12 +8,12 @@ on:
   # Uncomment the below lines to run this workflow on pull requests and pushes
   # to the default branch. This is useful for checking licenses before merging
   # changes into the default branch.
-  # pull_request:
-  #   branches:
-  #     - main
-  # push:
-  #   branches:
-  #     - main
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
   workflow_dispatch:
 
 permissions:

.github/workflows/linter.yml

@@ -51,3 +51,4 @@ jobs:
           VALIDATE_TYPESCRIPT_ES: false
           VALIDATE_JSON: false
           VALIDATE_TYPESCRIPT_STANDARD: false
+          VALIDATE_GITHUB_ACTIONS: false # false until linter schemas are updated to include the models permission

CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make 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 within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project email 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 `[email protected]`. 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`

CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# Contributing
+
+[fork]: https://github.com/actions/ai-inference/fork
+[pr]: https://github.com/actions/ai-inference/compare
+[code-of-conduct]: CODE_OF_CONDUCT.md
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your
+help is essential for keeping it great.
+
+Contributions to this project are
+[released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
+to the public under the [project's open source license](LICENSE).
+
+Please note that this project is released with a [Contributor Code of
+Conduct][code-of-conduct]. By participating in this project you agree to abide
+by its terms.
+
+## Found a bug?
+
+- **Ensure the bug was not already reported** by searching on GitHub under
+  [Issues](https://github.com/actions/ai-inference/issues).
+- If you're unable to find an open issue addressing the problem,
+  [open a new one](https://github.com/actions/ai-inference/issues/new). Be sure
+  to include a **title and clear description**, as much relevant information as
+  possible, and a **code sample** or a **reproducible test case** demonstrating
+  the expected behavior that is not occurring.
+- If possible, use the relevant bug report templates to create the issue.
+
+## What should I know before submitting a pull request or issue
+
+This project is written in [TypeScript](https://www.typescriptlang.org/), a
+typed variant of JavaScript, and we use [Prettier](https://prettier.io/) to get
+a consistent code style.
+
+Because of how GitHub Actions are run, the source code of this project is
+transpiled from TypeScript into JavaScript. The transpiled code (found in
+`lib/`) is subsequently compiled using
+[NCC](https://github.com/vercel/ncc/blob/master/readme.md) (found in `dist/`) to
+avoid having to include the `node_modules/` directory in the repository.
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+1. Configure and install the dependencies: `npm install`
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change, add tests, and make sure the tests still pass:
+   `npm run test`
+1. Make sure your code is correctly formatted: `npm run format`
+1. Update `dist/index.js` using `npm run build`. This creates a single
+   JavaScript file that is used as an entrypoint for the action
+1. Push to your fork and [submit a pull request][pr]
+1. Pat yourself on the back and wait for your pull request to be reviewed and
+   merged.
+
+Here are a few things you can do that will increase the likelihood of your pull
+request being accepted:
+
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you
+  would like to make that are not dependent upon each other, consider submitting
+  them as separate pull requests.
+
+## Releasing a new version
+
+All the concepts from
+[the actions/toolkit release docs](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md)
+apply. Please read that first!
+
+Once the changes are merged into main, a repository maintainer should:
+
+1. Bump the package version by running
+   [`npm version [major|minor|patch]`](https://docs.npmjs.com/cli/v7/commands/npm-version).
+   We adhere to [SemVer 2.0](https://semver.org/spec/v2.0.0.html) to the best of
+   our ability. Commit the changes to `package.json` and `package-lock.json` and
+   push them to main.
+1. [Draft a new release](https://github.com/actions/ai-inference/releases/new)
+   pointing to the ref of the version bump you just made. Publish the release to
+   the marketplace when complete.
+1. Finally: update the corresponding "major tag" (v1, v2, v3, etc) to point to
+   the specific ref of the release you just made. For example, if we just
+   released `v1.1.0`, we would rewrite the `v1` tag like this:
+
+```bash
+git tag -fa v1 v1.1.0 -m "Update v1 tag to point to v1.1.0"
+git push origin v1 --force
+```
+
+## Licensed
+
+This repository uses a tool called
+[Licensed](https://github.com/github/licensed) to verify third party
+dependencies. You may need to locally install licensed and run `licensed cache`
+to update the dependency cache if you install or update a production dependency.
+If licensed cache is unable to determine the dependency, you may need to modify
+the cache file yourself to put the correct license. You should still verify the
+dependency, licensed is a tool to help, but is not a substitute for human review
+of dependencies.
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)
+- [Writing good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+
+Thanks! :heart: :heart: :heart:
+
+GitHub Actions Team :octocat: