Neelix Simple Net Experience

This action creates a Neelix Experience where the Experience "weight" is derived from PR reviews. It's intended to be used only on pull_request: closed events and may break or have unexpected behavior on other events. If you're looking for an action with more direct control over the Experience created, check out create-experience-action.

This GitHub Action will serve as an invaluable tool for your development team, enabling you to seamlessly automate the assessment of joint coding practices. This offering is a Neelix.IO platform offering to support your workflow with the Team Journal. Empower a team culture that cares about the development quality of the code, identifes areas for improvement, and tracks progress over time. This automated approach not only streamlines the retrospective process but also fosters a culture of continuous growth and learning within the team. Through the insights gained, you will able to engage in more meaningful and potent retrospective conversations, highlighting both individual and collective strengths while pinpointing areas for enhancement. Ultimately, this collaborative effort will propel your team towards becoming an even more proficient and cohesive development unit, dedicated to delivering top-notch solutions and driving innovation.

Usage

You will first need to obtain a Neelix API token for your action. Directions can be found here. Be sure to keep your token secure. We recommend storing it as a secret. Next get the ID for the consortium for your experiences. This can be found using the API Developer helper tool. Provide the target consortium ID to the action, as well as any additional parameters you would like to include.

Example

name: Create Neelix Simple Net Experience

on:
  pull_request:
    types:
      - closed

jobs:
  create-simple-net-experience:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: read
    steps:
      - uses: neelix-io/simple-net-experience-action@v1
        with:
          api-token: ${{ secrets.API_TOKEN }}
          consortium-id: 017af22f-bffb-45a6-8272-01a6066195f3
          experience-summary: "My experience summary"
          activity-id: 275
          category-ids: 8056,3248,7297
          team-ids: 8806,9005
          keywords: |
            {
              "bad": -2,
              "needs improvement": -1,
              "okay": 1,
              "really great": 3,
            }

Inputs

• api-token (required): A valid Neelix API token with access to the specified consortium
• consortium-id (required): ID of target consortium
• experience-summary (required): Message to appear above table in experience commentary
• keywords (required): Keywords and weights to use in calculating weight for experiences. Should be provided as a JSON string (see example).
• activity-id: ID of an activity belonging to same consortium as experience. Sets activity_id field of new experience.
• category-ids: IDs of categories belonging to same consortium as experience. Adds specified categories to new experience. Use comma-separated list for multiple values (e.g. "1,2,3").
• team-ids: IDs of teams belonging to same consortium as experience. Adds specified teams to new experience. Use comma-separated list for multiple values (e.g. "1,2,3").
• table-header-keyword: Name used for "keyword" column. Default: "keyword"
• table-header-weight: Name used for "weight" column. Default: "weight"
• table-header-count: Name used for "count" column. Default: "count"
• table-header-total-impact: Name used for "total impact" column. Default: "total impact"
• github-token: GitHub token used to authenticate against GitHub API to retrieve PR review data. Default: GITHUB_TOKEN from github context.