Downloads:

1,803

Downloads of v 1.4.0:

19

Last Update:

13 Jul 2020

Package Maintainer(s):

Software Author(s):

  • Aviva Solutions

Tags:

azure devops teamcity build-monitoring delcom ci continuous integration

Beacon

This is not the latest version of Beacon available.

1.4.0 | Updated: 13 Jul 2020

Downloads:

1,803

Downloads of v 1.4.0:

19

Maintainer(s):

Software Author(s):

  • Aviva Solutions

Beacon 1.4.0

This is not the latest version of Beacon available.

All Checks are Passing

2 Passing Test


Validation Testing Passed


Verification Testing Passed

Details

To install Beacon, run the following command from the command line or from PowerShell:

>

To upgrade Beacon, run the following command from the command line or from PowerShell:

>

To uninstall Beacon, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade beacon -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade beacon -y --source="'STEP 3 URL'"
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure beacon installed
  win_chocolatey:
    name: beacon
    state: present
    version: 1.4.0
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'beacon' do
  action    :install
  version  '1.4.0'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: beacon,
    Version: 1.4.0,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller beacon
{
   Name     = 'beacon'
   Ensure   = 'Present'
   Version  = '1.4.0'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'beacon':
  provider => 'chocolatey',
  ensure   => '1.4.0',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install beacon version="1.4.0" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved as a trusted package on 13 Jul 2020.

Description

Beacon is a little command-line tool that lets you connect a Delcom USB RGB LED light or Shelly Bulb to a Azure Devops build pipeline or a set of TeamCity builds and use that to get an irrefutable indication on whether those builds succeeded, failed or are under investigation.

To get started just run the following command-line, for Azure DevOps and running continuously for definition id (ie. build) #1 and #2:

beacon azuredevops --url https://dev.azure.com/my-public-project --project MyProject --builds=1 2

or, using a personal access token or a private project and for all definitions:

beacon azuredevops --url https://dev.azure.com/my-public-project --project MyProject --builds=* --token 1234567890ab

or for TeamCity:

beacon --url=http://yourteamcity.com --username=username --password=password --builds=build_id_1 build_id_2 etc

or, alternatively using TeamCity guest access and running only once with verbose logging:

beacon --url=http://yourteamcity.com --guestaccess --runonce --verbose --builds=build_id_1 build_id_2 etc


tools\Beacon.1.4.0.zip
md5: DBEF7CF378277776AF1BB51294BEC74D | sha1: 06EF80C57606086888BF7FE54DB04CF7409FDA48 | sha256: 035D4715737AEC01D0FDFEF81B7FA02AA54235CA3ED3CE04949C2A2B24C14C2D | sha512: B3D10A614234413AB2DA49FDE53D233192BC4EA60B374B8D145508C42BD80336F72780F97F3D612E4AC25D9F194E78CAC7CAD30C2D1F7CB7217DFFF6473732D8
tools\LICENSE
 
tools\README.md
<!-- markdownlint-disable MD041 -->
![CI](https://github.com/avivasolutionsnl/Beacon/workflows/CI/badge.svg?branch=master)

# Beacon

A monitoring tool for Azure DevOps and Teamcity that uses a Delcom USB LED or Shelly Bulb light to notify your teams.

![Chocolate](./Images/Screenshot.png)

## How to install

The easiest deployment mechanism is to install [Chocolatey](https://chocolatey.org/) and run the following command-line to install the [Chocolate package](https://chocolatey.org/packages/beacon):

    choco install beacon

Then run `beacon` and observe the command-line arguments.

## Example usage
### Azure Devops
Using a public Azure Devops project and running continuously for definition id (ie. build) #1 and #2:

    beacon azuredevops --url https://dev.azure.com/my-public-project --project MyProject --builds=1 2

Or, using a personal access token (e.g. 1234567890ab, see [here](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page) for how to obtain a token) and for all definitions:

    beacon azuredevops --url https://dev.azure.com/my-public-project --project MyProject --builds=* --token 1234567890ab

### TeamCity
Using a named TeamCity account and running continuously:

    beacon teamcity --url=http://yourteamcity.com --username=username --password=password --builds=build_id_1 build_id_2 etc

Or, alternatively using TeamCity guest access, running only once and with verbose logging:

    beacon teamcity --url=http://yourteamcity.com --guestaccess --runonce --verbose --builds=build_id_1 build_id_2 etc

## Using a Shelly Bulb
First install your Shelly Bulb following the installation [instructions](https://shelly.cloud/documents/user_guide/shelly_bulb.pdf).
After your bulb is installed, look up the device IP address of it under "Settings > Device Information", e.g. 10.25.31.27.

Now use the obtained IP to connect Shelly:

    beacon azuredevops --url https://dev.azure.com/avivasolutions-public --project Nyxie --builds 10 --device shelly --shellyurl http://10.25.31.27

## Backlog

* Support for configuring the RGB values, flash mode and power level of the LED.
* Support for including all TeamCity projects under a certain project node, including more advanced filtering rules.
* Deployment as a Windows Service.

## Why another

My original idea was triggered by [TeamFlash](https://github.com/Readify/TeamFlash), a prototype implementation made by Readify. Unfortunately, the quality of that code was way below anything I can work with, so I planned to contribute a big list of improvements as well as more configuration options. However, it took me several emails, tweets and DMs and a month of patience just to get a [single pull request](https://github.com/Readify/TeamFlash/pull/16) accepted. So I see no point in working with a fork. Instead, I decided to take their code as a starting point and revive the product.
tools\VERIFICATION.txt

VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.
 
This package is published by the Beacon project itself. Any binaries will be 
identical to the ones published by the AppVeyor build mentioned on the GitHub 
project page.

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
Beacon 1.4.2 21 Monday, July 20, 2020 Approved
Beacon 1.4.1 27 Monday, July 13, 2020 Approved
Beacon 1.4.0 19 Monday, July 13, 2020 Approved
Beacon 1.3.0 313 Friday, September 7, 2018 Approved
Beacon 1.2.2 176 Friday, July 6, 2018 Approved
Beacon 1.1.1 411 Friday, April 21, 2017 Approved
Beacon 1.0.1 460 Tuesday, February 24, 2015 Approved

Added Azure DevOps and Shelly Bulb support.


This package has no dependencies.

Discussion for the Beacon Package

Ground Rules:

  • This discussion is only about Beacon and the Beacon package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Beacon, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus