Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/VinceFINET/OrgCheck into main
Browse files Browse the repository at this point in the history
  • Loading branch information
VinceFINET committed Feb 10, 2022
2 parents c6ddfab + a967f3d commit a523a41
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 6 deletions.
70 changes: 70 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ main, release-1.9 ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
schedule:
- cron: '17 9 * * 1'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://git.io/codeql-language-support

steps:
- name: Checkout repository
uses: actions/checkout@v2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
6 changes: 3 additions & 3 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
<p>{{ site.description | default: site.github.project_tagline }}</p>

{% if site.github.is_project_page %}
<p class="view"><a href="{{ site.github.repository_url }}" target="_blank">View the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
<p class="view"><a href="{{ site.github.repository_url }}" target="_blank" rel="external noopener noreferrer" >View the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
{% endif %}

{% if site.github.is_user_page %}
<p class="view"><a href="{{ site.github.owner_url }}" target="_blank">View My GitHub Profile</a></p>
<p class="view"><a href="{{ site.github.owner_url }}" target="_blank" rel="author noopener noreferrer">View My GitHub Profile</a></p>
{% endif %}

<p>
Expand Down Expand Up @@ -60,7 +60,7 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
</section>
<footer>
{% if site.github.is_project_page %}
<p>This project is maintained by <a href="{{ site.github.owner_url }}" target="_blank">{{ site.github.owner_name }}</a></p>
<p>This project is maintained by <a href="{{ site.github.owner_url }}" target="_blank" rel="author noopener noreferrer">{{ site.github.owner_name }}</a></p>
{% endif %}
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
Expand Down
28 changes: 25 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ permalink: /installation/
**OrgCheck** is a Salesforce application which can be installed on **any** Salesforce organization **very easily**. No additional infrastructure is required. No additional license. Simple as A.B.C.


## A) URLs for the installation
## Step 1: URLs for the installation

Go to one of the following URLs depending on the nature of the organization you want to install **OrgCheck**.

Expand All @@ -27,7 +27,7 @@ After selecting the previous URL, you were redirected to Salesforce servers.
If you were not yet authenticated, you will have to sign on using your credentials.


## B) Install the package
## Step 2: Install the package

Just like an AppExchange application you have to:
- Select the profiles -- we recommand to select **Admins Only**
Expand All @@ -38,7 +38,7 @@ For some orgs that have Apex class not compiling, you can install the package wi
![Installation Notice screenshot](../images/screenshots/OrgCheck-Screenshot-Install.png)


## C) Permission Set assignment
## Step 3: Permission Set assignment

Once installed, go to your org and assign your Salesforce user to the Permission Set called "OrgCheck Users".

Expand All @@ -58,3 +58,25 @@ We are also able to **push a new version** of the package in your org, to make s
We made the choice to use a specific **namespace** for this package, which is __OrgCheck__ of course, so that you can identify faster components of this package when browsing the metadata of your org (additionally to the naming convention).

Finally, the content of the application can be modified in your org (using the Salesforce Dev Console) in case you find a solution to a bug. Do not forget that every component of this package is under the MIT licence.


## Known issues

### I can't install the package because some Apex class are not compiling
- Our package does **NOT include ANY Apex class**.
- It is more likely a **existing Apex class** in the org you want to analyze that **does not compile** (it happens!).
- In that case, you can still install the package BUT you will have to specify during the installation process that you only want to validate the classes that are included in the package. This can be done via the **advanced setting when installing the app**.

### I can't see the OrgCheck application, even if I am SysAdmin and/or are assigned the OrgCheck Permission set
- The app is called "**OrgCheck**" obviously, maybe you spell it wrong?
- Double check that you are assigned to the **permission set** (just in case you missed that part).
- You should see the application definitly!

### I have the same error on EVERY tabs when the tool is accessing the API: INVALID_SESSION_ID: This session is not valid for use with the REST API
In case you have enabled the "**API Client Whitelisting**" feature, you will need to:
- Create another permission set (don't modify the OrgCheck permission because on the next release your setting will be overwritten).
- In this permission set, check the system permission called "**Use any API Client**" (which appears ONLY if you activate the "**API CLient Whitelisting**" feature -- that's why we can't add it to everybody).
- And assign your user to this additional permission set.
For more information, you can check that closed issue: https://github.com/VinceFINET/OrgCheck/issues/118


0 comments on commit a523a41

Please sign in to comment.