AURA: The OSCR Developer (Automated Universal Routing Assistant)

AURA is a VS Code extension that automates event integration, code generation, and developer workflow for Java Spring Boot projects, with a focus on the osos-oscr-comms-router and similar workspaces.

Key Features

🚀 AURA: Integrate new Event in Oscr Router

Complete end-to-end automation for event integration:

• Code Generation: Creates Java builder and processor classes based on existing event patterns
• Git Workflow: Creates a new branch with naming convention aura-{JIRA_TICKET}
• Automatic Commit & Push: Stages all changes and commits to the new branch
• Pull Request: Automatically creates a PR against the master branch
• Jira Integration: Comments the PR link on the specified Jira ticket

🎯 AURA: Add requests to aura_requests

• Add any number of free-form, natural language requests for workspace changes
• Integrates with GitHub Copilot for intelligent code generation

📝 AURA: Commit and Create PR for aura_requests Changes

• Commits only files under the src directory (excludes config/docs)
• Creates a new branch and pull request for Copilot-generated changes

Requirements

• VS Code with the AURA extension installed
• Java Spring Boot project (osos-oscr-comms-router or similar)
• Git repository with push access
• GitHub/GitHub Enterprise access for PR creation
• Jira access for ticket commenting (optional)
• aura.config.json configuration file in workspace root

Configuration

Setup: aura.config.json

Create a configuration file named aura.config.json in your workspace root with the following structure:

{
  "githubRepoWithCreds": "https://{username}:{token}@github.com/org/repo.git",
  "githubRepo": "https://github.com/org/repo.git",
  "gitUserName": "Your Name",
  "gitUserEmail": "your.email@company.com",
  "githubApiToken": "ghp_xxxxxxxxxxxxxxxxxxxx",
  "jiraBase": "https://your-company.atlassian.net",
  "jiraEmail": "your.email@company.com",
  "jiraToken": "your_jira_api_token"
}

Configuration Fields:

• githubRepoWithCreds: Git repository URL with embedded credentials for push operations
• githubRepo: Public repository URL (used for PR creation)
• gitUserName: Your Git username for commits
• gitUserEmail: Your Git email for commits
• githubApiToken: GitHub Personal Access Token for PR creation
• jiraBase: Your Jira instance base URL
• jiraEmail: Your Jira email
• jiraToken: Jira API token for commenting on tickets

Getting Tokens:

• GitHub Token: Go to GitHub Settings → Developer settings → Personal access tokens
• Jira Token: Go to Jira Account Settings → Security → API tokens

Usage

Event Integration Workflow

1. Open the command palette (Ctrl+Shift+P)
2. Run AURA: Integrate new Event in Oscr Router
3. Provide the following when prompted:
   • GitHub repository URL
   • Jira ticket number (e.g., ACIP-434790)
   • Event name (e.g., VIBE_CODE)
   • Reference event with similar payload
   • Builder class name
   • Processor class name
   • Target workspace path
4. AURA will:
   • Generate new Java builder and processor classes
   • Update configuration files and registrations
   • Create branch aura-{JIRA_TICKET}
   • Commit and push changes
   • Create a pull request
   • Comment PR link on Jira ticket

Copilot-Style Automation

1. Run AURA: Add requests to aura_requests
2. Enter free-form requests (e.g., "Add a REST endpoint for user management")
3. Open the generated aura_requests file
4. Use GitHub Copilot to process and apply changes
5. Run AURA: Commit and Create PR for aura_requests Changes when ready
6. Confirm changes and provide branch name
7. AURA creates branch, commits only src/ changes, and opens PR

Extension Settings

This extension does not require additional VS Code settings. All configuration is handled through aura.config.json.

Troubleshooting

• Missing config error: Ensure aura.config.json exists in workspace root
• Git authentication issues: Verify githubRepoWithCreds has valid credentials
• PR creation fails: Check githubApiToken permissions and repository access
• Jira comment fails: Verify jiraToken and jiraBase URL

Known Issues

• Only supports Java Spring Boot project structure
• Requires manual setup of aura.config.json
• Limited to GitHub and Jira integrations currently

Release Notes

0.0.1

• Initial release with automated event integration
• Added Copilot-style workspace automation
• Git workflow automation (branch, commit, PR)
• Jira ticket integration

Development

Following Extension Guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Building and Testing

npm install           # Install dependencies
npm run compile       # Compile TypeScript
npm test             # Run tests
npx vsce package     # Package extension

License

This project is licensed under the MIT License.

Enjoy using AURA for your automation needs!