Reporting Problems

Found a Bug?

A lot of work has gone into this project, aiming to cater for many different versions of Outlook and types of usage. If you discover a bug, please help squash it! 🪲

Make sure you are using the latest (alpha if available) via one of the two options below:
- Upgrade through OGCS:
  - Go to the About tab and tick the Check for Alpha releases box
  - Click Check For Update
- Download the latest version directly from the project website
- Download the OGCS_Setup.exe Assets file from the GitHub releases page
Search existing Issues - see if it's already been reported.
- There may already be a hotfix available.
- You may be able to add value information to help fix it!
- Subscribe to the Issue to receive update notifications.
Reckon it's a brand new Issue? Read on to log it!

🚫 Do not post issues about Outlook security pop-ups unless you have read and understood why it's happening and have something further to add.

Submitting an Issue

Create a new Bug Report Issue. Describe the problem, including:

Version of OGCS
What you did to produce the problem
Does it repeatedly happen/is it a reproducible issue
Include your log file (see below)

⚠️ Don't upload the settings.xml file unless requested, and definitely don't upload Google.Apis.Auth.OAuth2.Responses.TokenResponse-user - this is your private key to update your Google account.

Locating Your OGcalsync.log File

Note: The OGcalsync.log file will have details of your calendar items and other attributes, depending on the logging level set.

If OGCS can be opened, go to Settings > Application Behaviour > Open Log.
Otherwise open Windows Explorer and in the address bar enter %APPDATA%\Outlook Google Calendar Sync.

🗒️ If you're running in portable mode, then navigate to wherever you are running OGCS from.

Posting Your OGcalsync.log File

Create a Gist 👍

These can be public (your files can be seen against your profile) or private (only those with the link can see it).

Create a new gist, paste in your OGcalsync.log contents and save it.
- If it's public, copy the URL to the comment of the Issue it's related to.
- If it's private, email me with the URL, or view my GitHub profile page for other ways of contacting.

Attach File

Attach the file directly to the Issue.
If you also want to upload older log files, for example if you have logging set at FINE and it is producing a lot of output, then this will require you to either:

change the end of the filename(s) to .log - i.e from OGcalsync.log.2019-04-15 to OGcalsync.log.2019-05-15.log; or
to zip up all the logfiles (eg issue-123-logs.zip) and upload

Upload to Developer's Google Drive

Upload to my Google Drive via this Google Form

Use Your Own DropBox/Google Drive

Pick your tool of choice and email me with a link to the file, or view my GitHub profile page for other ways of contacting.

Applying a Hotfix

If the issue requires a fix, a zipped hotfix executable will be posted to the Issue page. Note that hotfixes posted across different issues are not cumulative unless specifically stated - i.e hotfix 2.7.8.5 on issue 321 does not include hotfix 2.7.8.3 from issue 123.

To test a hotfix:

Check You are on the Latest Alpha Release

Run the OGCS application and go to the "About" tab
Make sure the first three sets of numbers matches that of the hotfix. For example, if hotfix 2.7.8.3 has been release, you need to be running 2.7.8.0. If you are on a previous version, eg 2.7.4.0, you must upgrade before applying the hotfix.

Find the Location Where the Application Executable is Running From

On the "About" tab double-click the "Running From" value to open the path in Windows Explorer
- The directory will be something like: C:\Users\<userid>\AppData\Local\OutlookGoogleCalendarSync\app-<release>

✋ It is important you carry out the below instructions in this directory, eg app-2.7.8-alpha and not the parent directory C:\Users\<userid>\AppData\Local\OutlookGoogleCalendarSync\

Exit the OGCS application
Copy or rename your existing OutlookGoogleCalendarSync.exe file
Download the hotfix zip file and extract its file(s) to your application directory, eg app-2.7.8-alpha
Run the OGCS application
- You may need to unblock the hotfix executable if Windows Defender or some anti-virus has a problem with it.
Confirm in the "About" tab the version shows the hotfix number eg. 2.7.8.3