Coder Social home page Coder Social logo

microsoft / banner-settings-ado-extension Goto Github PK

View Code? Open in Web Editor NEW
17.0 9.0 16.0 1.92 MB

Banner Settings provides a settings pane under Organization Settings to allow Project Collection Administrators to show sitewide banners. Alert your Azure DevOps users to upcoming changes or events without sending out mass emails. Compatible with Azure DevOps Services and Server.

License: MIT License

CSS 6.29% TypeScript 85.60% HTML 0.80% JavaScript 7.30%

banner-settings-ado-extension's Introduction

Build Status

Banner Settings provides a settings pane under Organization Settings to allow Project Collection Administrators to show sitewide banners. Alert your Azure DevOps users to upcoming changes or events without sending out mass emails. Compatible with Azure DevOps Services and Server.

Features

  • Show banners on any page in Azure DevOps.
  • Choose between three types (levels) of messages: Info, Warning, and Error.
  • Choose an expiration date for a message.
  • Include hyperlinks in your banners using markdown syntax like the banner message below.
Windows October Update released! Please visit the [Windows Insider Blog](https://blogs.windows.com/windowsexperience/tag/windows-insider-program/) for more info.

Restrictions

  • Only one banner can be shown at a time to keep the interface clean. Banners are prioritized by level. For example, if you have posted a warning message and an info message, the info message will only be shown after a user closes the warning message, or you delete the warning message.
  • Banners are restricted to a length of thirty words.

Building the project

Just run:

npm run build:dev
npm run package:dev

This produces a .vsix file which can be uploaded to the Visual Studio Marketplace

Publish it to your own publisher by running:

npm run publish:dev

You can then serve the extension locally and visit your newly published dev environment extension using

npm run dev

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

banner-settings-ado-extension's People

Contributors

j-windsor avatar microsoft-github-operations[bot] avatar microsoftopensource avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

banner-settings-ado-extension's Issues

There was an error loading the banners: Cannot read properties of undefined (reading 'toLocaleLowerCase')

Getting this error with Azure DevOps Server 2020 when clicking on the banner extension:

"There was an error loading the banners: Cannot read properties of undefined (reading 'toLocaleLowerCase')"

It allows us to create new banners successfully. However it will not list any existing banners.

We were using the Azure DevOps extension for Azure CLI prior to getting the banner extension from the marketplace. Perhaps could that be why it is throwing an error? Does it not like the older banners?

When we run the "az devops admin banner list" command, everything looks fine. No issues listing all the banners.

We do notice the banners created from the extension show an ID number added to them that starts with "p2-" followed by a 13 digit number. (The banners created from command do not have this.)

Set to Expire is not working in my case

Hi people

  Simply "Set to expire" is not working in my case. I have a Azure Devops organizacion set in _UTC -05:00 Bogota, Lima, Quito Rio Branco_

If I set the banner without "set to expire" banner appears fine. But (example: today 08-19-2023) if I set expire date for next monday (08-21-2023) banner disappers and I have no error.

Someone else have this problem?
banner

Project Settings

The banner extension does not show up for DevOps Server - on Prem. I only have "Project Settings" not "Organization Setting". But its listed in the compatibility settings of the extension. Am I missing something? Or are different instructions required?

Thanks

Suggestion: ChatOps Integration - Post Message from MS Teams

It would be great if there was a way to hook to this tool from a chat client, so that I could tag a bot with the message to post. For example, chat input = "@ChatBotForAZDBanner Post this message on my AZD banner" . I realize this solution goes beyond your extension alone, and would require the chat client to have capabilities for calling the Azure REST API. But assuming the client was capable, could this extension expose an API method within AZD?
Also, I've noticed there are already a few Azure Devops plugins for MS TEAMS, but they use web hooks to simply recieve info from AZD, not push anything. In fact, it looks like there is no current capability in MS Teams for any type of connections (bots) that push data out to external endpoints - at least as far as I can tell. Any idea if "ChatOps" is something Microsoft has on the roadmap?

Show more then the first banner

It would be nice, if more then one banner is active, the extension should shows all banners to the user.
Currently it shows only the oldest one.

Permission management

Hello!

The extensions does exactly what it states, thanks for sharing it! However, I have a question about permissions.
In code I see no explicit permission validation, if user actually being a member of Project Collection Administrators (PCA) group or not, but verified it is working, as expected, only for PCAs. Do i get it right that code just relies on fact that API call will be failing if personal token gets rejected by some ADO internal permission policies? Or am I missing something?

Thanks

Banners stopped working on TFS 2018

I had banners working on TFS 2018, today I went to use them and it said it would not load. I uninstalled the extension and then tried to reinstall and now it says 2018 is not supported.

Will you bring it back?

Display banner per project or per organization

Feature request to be able to show a banner in specific projects instead of the whole organization. The banner creator should have the choice to pick where the banner displays. It could be for the whole organization or it could be one or more projects.

Server wide banners

We run some on-premise ADO Servers with many collections. Today we use the banner extension to inform users about events like upcoming service, tips and other stuff.
When doing this on a server with 20+ collections and you need to publish the same banner in all collections it would be very nice to have an option to publish the banner once for all collections in the server.

What permissions do we require to update banner using PAT token.

Hi team,

we are using PowerShell runbook to create banner, it worked fine with ADO full access PAT Token, but the ADO full access pat token is restricted now. We created a PAT token with all read/write/manage permissions but still when we hit banner API it is throwing 401 unauthorized error.
can you please let us know what exact permissions needed for PAT token.

Regards,
Kalyani.

Banner disappears permanently

Once you close a banner message, it disappears permanently - even after logging out/in again or restarting the browser. Is that the intended behavior?
If so, I think this behavior should be configurable, so I can ensure some messages display again later, like in the next user login session, or after a certain amount of time (like a recurring reminder). It would also be nice if global default settings were available to allow you to set default behavior for each of the message types.

Cannot delete banners

Hello,

We have a DEV and PROD DevOps Organization, our user is Project Collection Administrator on both side.

When I click to the Delete button on a banner, the affected banner will be removed from the list - the Extension works as expected.

However, it will be available again after refresh the browser page on the PROD but still removed on the DEV Organization.

Have you any idea?

Is there any special permission or Organization-level settings which needed to the Extension?

Regards,
Gabor

Message in bold or italic format

Can we write the message( info,warning,error) in bold or italic format??
and can we add multiple banners in different projects??

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.